Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
58 lines (39 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

58 lines (39 loc) · 1.87 KB

Contributing to FTP-Sync

First off, thank you for considering contributing to FTP-Sync! It's people like you that make FTP-Sync such a great tool.

Getting Started

  • Make sure you've got Node.js and npm up and running.
  • Clone the repository: 
    git clone https://github.com/slippyex/ftp-sync.git
  • Navigate to the project directory: 
    cd ftp-sync
  • Install the dependencies: 
    npm install

Code of Conduct

We have a Code of Conduct in place. Please go through it before contributing. We pledge to make participation in our community a harassment-free experience for everyone.

How Can I Contribute?

Reporting Bugs

Ensure the bug was not already reported by searching on GitHub under Issues. If you're unable to find an open issue addressing the problem, open a new one.

Suggesting Enhancements

If you have ideas or wish to enhance a feature, glide over to the issues page and drop a word.

Pull Requests

  1. Fork the repo.
  2. Create a new branch (git checkout -b feature/MyNewFeature).
  3. Commit your changes (git commit -am 'Add some feature').
  4. Push to the branch (git push origin feature/MyNewFeature).
  5. Open a new Pull Request.

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature").
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
  • Limit the first line to 72 characters or less.
  • Reference issues and pull requests liberally after the first line.

TypeScript Styleguide

All TypeScript must adhere to the TypeScript standard styleguide.

Thank you for your interest in contributing to FTP-Sync. Your efforts are highly appreciated!