Skip to content

Latest commit

 

History

History
executable file
·
32 lines (26 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
32 lines (26 loc) · 1.45 KB

Contributing to project-name

First off, thanks for taking the time to contribute to my project! It'll be of great help fr me !

Now please, take a moment to be sure your contributions make sense to everyone else. Remember : these are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Reporting Issues

Found a problem? Want a new feature? First check if your issue or idea has already been reported. Don't? Then please just open a new clear and descriptive issue.

Submitting pull requests

Pull requests are the greatest contributions, so be sure they are focused in scope, and do avoid unrelated commits.

  • Fork it!
  • Clone your fork: git clone https://github.com/<your-username>/<project-name>
  • Navigate to the newly cloned directory: cd project-nam
  • Create a new branch for the new feature, a branch for each one new feature please : git checkout -b my-new-feature
  • Install the tools necessary for development: npm install
  • Make your changes.
  • Commit your changes: git commit -am 'Add some feature'
  • Push to the branch: git push origin my-new-feature
  • Submit a pull request with full remarks documenting your changes.

Testing

Every time you write a test, remember to answer all the questions:

  1. What are you testing?
  2. What should it do?
  3. What is the actual output?
  4. What is the expected output?
  5. How can the test be reproduced?