Thank you for your interest in contribution to go-financial. Here's the recommended process of contribution.
If you've changed APIs, update the documentation. Make sure your code lints. Issue that pull request!
- Fork the repo and create your branch from master.
- hack, hack, hack.
- If you've added code that should be tested, add tests.
- If the functions are exported, make sure they are documented with examples.
- Update README if required.
- Make sure that unit tests are passing
make test-unit. - Make sure that lint-checks are also passing
make lint-check. - Make sure that your change follows best practices in Go
- Open a pull request in GitHub in this repo.
When you work on a larger contribution, it is also recommended that you get in touch with us through the issue tracker.
All submissions, including submissions by project members, require review.
Releases are partially automated. To draft a new release, follow these steps:
- Decide on a release version.
- Create a new release/{version} branch and edit the
CHANGELOG.md. - Make sure that the tests are passing.
- Get the PR merged.
- Tag the merge commit (
vX.Y.Z) and create a release on GitHub for the tag. (repo maintainers) - (Required) Sit back and pat yourself on the back for a job well done 👏.