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

git clone https://github.com/Your-Username/gprMax.git

Navigate to the project directory.
```
cd gprMax
```

Add a reference(remote) to the original repository.

git remote add upstream https://github.com/gprMax/gprMax.git

Check the remotes for this repository.
```
git remote -v
```
Always take a pull from the upstream repository to your devel branch to keep it at par with the main project (updated repository).
```
git pull upstream devel
```
Create a new branch.
```
git checkout -b <your_branch_name>
```
Run the following command before you commit your changes to ensure that your code is formatted correctly:
```
pre-commit run --all-files
```
Make the changes you want to make and then add
```
git add .
```
Commit your changes. To contribute to this project
```
git commit  -m "<commit subject>"
```
Push your local branch to your fork
```
git push -u origin <your_branch_name>
```
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.

2.8 KiB 原始文件 永久链接 Blame 文件历史