Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (29 loc) · 1.84 KB

CONTRIBUTING.md

File metadata and controls

40 lines (29 loc) · 1.84 KB
Raw

Contributing :

First of all, thanks for thinking of contributing to this project! 👏

Following these guidelines helps to communicate that you respect the time of the maintainer and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

This project has a Contributor Covenant Code of Conduct. By participating in this project you agree to abide by its terms.

Ways to Contribute

  • Blog or tweet about the project
  • Improve documentation
  • Fix a bug
  • Implement a new feature
  • Discuss potential ways to improve project
  • Improve existing implementation, performance, etc.

Questions & Feature Requests

Feel free to open a ticket with your question. Feature requests are also welcome. Describe the feature, why you need it, and how it should work. Please provide as much detail and context as possible.

File a Bug

In case you've encountered a bug, please make sure:

  1. Check out our [public issues board][0]. If your issue isn't on the board, [open a new one][1].
  • In your issue description, please include:
    • What you expected to see, and what happened instead.
    • Interesting logs.
    • All steps to reproduce the issue.
  1. Fork the project ([Need help forking a project?][3]). You'll do all of your work on your forked copy.
  2. Create a branch specific to the issue or feature you are working on. Push your work on that branch ([Need help with branching?][4]).
  3. Name the branch something like fixes-xxx-issue or add-xxx-feature where xxx is a short description of the changes or feature you are adding.
  4. Once your code is ready, submit a pull request from your branch to Shipr's master branch. We'll do a quick review and give you feedback.