|
| 1 | +# Contributing Guide |
| 2 | + |
| 3 | +Please read this document in its entirety. |
| 4 | + |
| 5 | +## General |
| 6 | + |
| 7 | +- Be nice and respectful of maintainers’ and contributors’ time and viewpoints |
| 8 | +- Be as descriptive as possible! More info is always better than not enough |
| 9 | +- Be patient, there may be a lot of in-flight work, some of it across multiple projects not related to the repo being contributed to |
| 10 | +- Have fun! |
| 11 | + |
| 12 | +## Contributing |
| 13 | + |
| 14 | +Contributing comes in many forms! We are incredibly grateful to anyone who can do any of the following: |
| 15 | + |
| 16 | +- Add new features |
| 17 | +- Fix bugs |
| 18 | +- Fix typos |
| 19 | +- Improve docs |
| 20 | +- Improve tests |
| 21 | +- Triage issues |
| 22 | +- Review pull requests |
| 23 | +- Share opinions and viewpoints on issues |
| 24 | + |
| 25 | +## Issues |
| 26 | + |
| 27 | +- If your issue is security related, please follow the [SECURITY guide](https://github.com/easypost/.github/SECURITY.md) |
| 28 | +- Before opening a new issue, check for existing issues that are related, including closed ones |
| 29 | +- Provide as much information as possible about the issue, including how to reproduce the problem and the expected behavior |
| 30 | +- Don't needlessly bump issues (eg: if there hasn’t been progress for more than a few weeks, feel free to reach back out) |
| 31 | + |
| 32 | +## Pull Requests |
| 33 | + |
| 34 | +- All Pull Requests should be accompanied first by an issue describing the reason why the Pull Request is needed |
| 35 | +- Be as descriptive as possible in your PR description about why the changes are being made and what the changes contain |
| 36 | +- Pull Requests should be as small as possible |
| 37 | +- Don't make unrelated changes in your Pull Request |
| 38 | +- Don't open a Pull Request if you don't plan to see it through. PRs submitted by individuals that cannot complete additional work to get a PR merged may be closed without completion |
| 39 | +- Adhere to the existing code style of the repo, even if it differs from your personal preference |
| 40 | +- When applicable, add tests that provide ample coverage of the logic added or changed |
| 41 | +- Pull Requests should come from branches and never the default `master` branch |
| 42 | +- Pull Requests must pass CI, including linting and testing |
| 43 | +- Pull Requests must go through code review before they can be merged to the main branch |
| 44 | +- Do not include "version bump" changes in the same PR as your code changes; these will be handled as a separate PR and releasing process |
| 45 | +- Make sure the `Allow edits from maintainers` checkbox is checked. That way EasyPost engineers can make certain minor changes as needed, allowing your pull request to be merged sooner. |
| 46 | + |
| 47 | +You agree and acknowledge that you have necessary intellectual property rights to provide your Contribution and hereby assign to EasyPost all right, title and interest in such Contribution. |
0 commit comments