Skip to content

Latest commit

 

History

History
37 lines (27 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

37 lines (27 loc) · 1.48 KB
Raw

Contributing

If you are thinking of contributing code to this project, first of all, thank you! All fixes, patches and enhancements to it are very warmly welcomed.

Please take a moment to review this document in order to find how your contribution can be possible.

Bugs and Feature Requests

The preferred way to report bugs or request features is to use GitHub issues. For this project, however, that feature is not available.

Pull Requests

  1. Create a GitHub account (if you don't have one already)
  2. Fork this project
  3. Create your feature branch: git checkout -b my-new-feature
  4. Make your changes
  5. Commit your changes: git commit -am 'Add some feature'
  6. Push to the branch: git push origin my-new-feature
  7. Submit a pull request

Before you submit a pull request from your forked repo, check that it meets these guidelines:

  • If the pull request adds or changes a functionality, make sure the documentation is also created or updated as part of the same pull request.
  • Try not to put more than one feature or bug fix in a single pull request. Create a separate pull request for each feature or bug fix.
  • Squash your commits into one for each pull request: git reset --soft HEAD~<NUMBER_OF_COMMITS> && git commit.

License

By contributing to this project, you agree that your contributions will be licensed under its LICENSE.