The following is a set of guidelines for contributing to oneseismic-api.
Some of the ways you can help:
- Submitting bug reports: see Issues.
- Proposing code for bug fixes and new features, then making a pull request.
- Fixing typos and generally improving the documentation.
- Writing tutorials, examples, and how-to documents.
- Work on your own fork of the main repo.
- Push your commits and make a draft pull request.
- Check that your pull request passes all tests.
- When all tests have passed and you are happy with your changes, change your pull request to "ready for review", and ask for a code review.
We strive to keep a consistent and clean git history and all contributions should adhere to the following:
- All tests should pass on all commits
- A commit should do one atomic change on the repository
- The commit headline should be descriptive and in the imperative.
- Commit description should be added to commits which require context (explanation why the commit was introduced, reasoning for taken decisions, important information about commit consequences, etc).
Add tests of appropriate level for all new functionality/fixed bugs.
Style code similarly to neighboring code. Apply gofmt for go code. Follow
standard language conventions and existing project conventions.