Contribution Guidelines
Our Contribution Guidelines
Welcome to Tugboat! We want to make contributing to this project as easy and transparent as possible. Contributions are released to the public under the open source license of this project.
Code of Conduct
Please make sure to read and observe the Code of Conduct.
About
We use github to host code, to track issues and feature requests, as well as accept pull requests.
All code changes happen through pull requests
Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests.
- Fork the repo and clone the repository.
- Create a new branch using
git checkout -b my-branch-name. - If you’ve added code that should be tested, add tests.
- If you’ve changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
- Push to your fork and submit a pull request.
Report bugs using Github’s issues
We use GitHub issues to track bugs. Report a bug by opening a new issue on GitHub.
Great Bug Reports tend to have:
- A quick summary and/or background
- Steps to reproduce
- Be specific
- Give sample code if you can
- What you expected would happen
- What actually happens
- Notes (optionally including why you think this might be happening, or stuff you tried that didn’t work)