If you want to contribute to the project and make it better, your help is very welcome. Contributing is also a great way to learn more about social coding on Github, new technologies and and their ecosystems and how to make constructive, helpful bug reports, feature requests and the noblest of all contributions: a good, clean pull request.
Report bugs at https://github.com/equinor/pysand/issues with the label "bug". Please include:
- Your operating system name and version.
- Any details about your Python environment.
- Detailed steps to reproduce the bug.
The best way to send feedback is to open an issue at https://github.com/equinor/pysand/issues with the label "enhancement". If you are proposing a new feature:
- Explain in detail how it should work.
- Keep the scope as narrow as possible, to make it easier to implement.
Look through the Git issues for feature requests. Anything tagged with "enhancement" is open to whoever wants to implement it.
Writing new code is not the only way to get involved and contribute. Creating examples and/or improving the existing ones is very much encouraged.
Ready to contribute?
- Assign yourself to the issue in the issue list
- Fork the
PySandrepo - Clone your fork locally
- Create a branch for local development
- Make your changes locally
- Commit your changes (with reference to the issue) and push your branch to GitHub
- Submit a pull request through the GitHub website
Before you submit a pull request, check that it meets these guidelines:
- The pull request should include new tests for all the core routines that have been developed
- An increment to
version.pyshould be made - The change log should be updated (
changelog.md)