你已经派生过 gprMax
镜像自地址
https://gitee.com/sunhf/gprMax.git
已同步 2025-08-06 12:36:51 +08:00
83 行
2.8 KiB
Markdown
83 行
2.8 KiB
Markdown
# 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](https://opensource.guide/how-to-contribute/), this guide helps explain why, what, and how to get involved.
|
|
|
|
## How can you help us?
|
|
|
|
* Report a bug
|
|
* Improve our [documentation](https://docs.gprmax.com/en/devel/)
|
|
* Submit a bug fix
|
|
* Propose new features
|
|
* Discuss the code implementation
|
|
* Test our latest version which is available through the [devel branch](https://github.com/gprmax/gprMax/tree/devel) on our repository.
|
|
|
|
## How to Contribute
|
|
|
|
In general, we follow the "fork-and-pull" Git workflow.
|
|
|
|
1. Fork the gprMax repository
|
|
2. Clone the repository
|
|
```bash
|
|
git clone https://github.com/Your-Username/gprMax.git
|
|
```
|
|
3. Navigate to the project directory.
|
|
```bash
|
|
cd gprMax
|
|
```
|
|
4. Add a reference(remote) to the original repository.
|
|
```bash
|
|
git remote add upstream https://github.com/gprMax/gprMax.git
|
|
```
|
|
5. Check the remotes for this repository.
|
|
```bash
|
|
git remote -v
|
|
```
|
|
6. Always take a pull from the upstream repository to your devel branch to keep it at par with the main project (updated repository).
|
|
```bash
|
|
git pull upstream devel
|
|
```
|
|
7. Create a new branch.
|
|
```bash
|
|
git checkout -b <your_branch_name>
|
|
```
|
|
8. Run the following command before you commit your changes to ensure that your code is formatted correctly:
|
|
|
|
```bash
|
|
pre-commit run --all-files
|
|
```
|
|
9. Make the changes you want to make and then add
|
|
```bash
|
|
git add .
|
|
```
|
|
10. Commit your changes. To contribute to this project
|
|
```bash
|
|
git commit -m "<commit subject>"
|
|
```
|
|
11. Push your local branch to your fork
|
|
```bash
|
|
git push -u origin <your_branch_name>
|
|
```
|
|
12. 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](https://github.com/gprMax/gprMax/issues).
|
|
|
|
## 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](https://groups.google.com/g/gprmax) (Forum) for comments, interaction with other users, chat, and general discussion on gprMax, GPR, and FDTD.
|
|
|
|
Checkout our website [gprmax.com](https://www.gprmax.com/) for more information and updates.
|