2.0 KiB
Contributing to gprMax
Thank you for your interest in contributing to gprMax, we really appreciate your time and effort!
If you’re unsure where to start or how your skills fit in, reach out! You can ask us here on GitHub, by leaving a comment on a relevant issue that is already open.
Small improvements or fixes are always appreciated.
If you are new to contributing to open source, this guide helps explain why, what, and how to get involved.
How can you help us?
- Report a bug
- Improve our documentation
- Submit a bug fix
- Propose new features
- Discuss the code implementation
- Test our latest version which is available through the devel branch on our repository.
How to Contribute
In general, we follow the "fork-and-pull" Git workflow.
- Fork the gprMax repository
- Clone the repository
- Make the changes you want to make
- Run the following command before you commit your changes to ensure that your code is formatted correctly:
pre-commit run --all-files
- Commit your changes locally as you progress
- Push your local branch to your fork
- Submit a Pull request so that we can review your changes
NOTE: Be sure to merge the latest from "upstream" before making a pull request!
Feature and Bug reports
We use GitHub issues to track bugs and features. Report them by opening a new issue.
Code review process
The Pull Request reviews are done frequently. Try to explain your PR as much as possible using our template. Also, please make sure you respond to our feedback/questions about the PR.
Community
Please use our Google Group (Forum) for comments, interaction with other users, chat, and general discussion on gprMax, GPR, and FDTD.
Checkout our website gprmax.com for more information and updates.