Skip to content

Latest commit

 

History

History
45 lines (29 loc) · 1.56 KB

CONTRIBUTING.markdown

File metadata and controls

45 lines (29 loc) · 1.56 KB
Raw

Contributing to the repository

This rules are based on the ones from kowainik repos.

Greetings Traveler!

We are delighted you're reading this, and we appreciate the effort you're taking to make our projects awesome! ✨

How to contribute

Report bugs or feature request

If you discover a bug or have any proposals on how to make this project better don't hesitate to create an issue here in a free format.

Create a PR

We love to receive pull requests from everyone! It's usually a good idea to tell about your intention to work on something under the corresponding issue, so everyone is aware that you're on it. If there's no such issue — simply create a new one!

To get started with the Pull Request implementation you should first fork, then clone the repo:

git clone git@github.com:your-username/project-name.git

Make your changes and consider the following checklist to go through before submitting your pull request.

Check list

  • New/fixed features work as expected (Bonus points for the new tests).

  • There are no warnings during compilation.

  • Commit messages are in the proper format. Start the first line of the commit with the issue number in square parentheses.

    Example: [#42] Upgrade upper bounds of 'base'

After all above is done commit and push to your fork. Now you are ready to submit a pull request.

Thanks for spending your time on reading this contributing guide!