Skip to content

Latest commit

 

History

History
25 lines (12 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

25 lines (12 loc) · 1.5 KB

Contributing to Shipanther

👍🎉 First of all, thanks for taking the time to contribute to Shipanther! 🎉👍

  • Do not open up a GitHub issue if you a security vulnerability in Shipanther, and instead to refer to our security policy.

There are many ways in which you can contribute to Shipanther. You can contribute by implementing any of the open issues here. Just drop a note on the issue before starting so that we can avoid any duplication of effort. Issues tagged as good first issue are usually a good starting point if you are new to the project.

If you are not a developer, you can contribute in other ways by providing feedback and by requesting new features. You can create a new issue with the details so that we can review it.

We are always looking for code reviews on PRs. Feel free to add your review comments to any open PRs.

Note to developers

Please ensure that appropriate tests are added for any new functionality or a bug fix. You can run existing tests via make lint test before opening the PRs. When adding any new features or third-party libraries, please ensure that all platforms in this project are supported.

Local setup

For steps and guides, please go through the project wiki.

Code of Conduct