The following is a set of guidelines for contributing to segyio.
There are several important ways you can help; here are some examples:
- Submitting bug reports and feature requests: 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.
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
- 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 your are happy with your changes, change your pull request to "ready for review", and ask for a code review.
- When your code has been approved you should rebase, squash and merge your changes.