diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 03b963b3..95739200 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -1,4 +1,4 @@ -name: Bug report +name: "\U0001F41E Bug report" description: Create a report to help us improve labels: ["bug"] body: @@ -53,4 +53,4 @@ body: label: gprMax version placeholder: gprMax v.3.1.6 validations: - required: false + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml index 9e6cfade..942f9e79 100644 --- a/.github/ISSUE_TEMPLATE/config.yaml +++ b/.github/ISSUE_TEMPLATE/config.yaml @@ -1,7 +1,10 @@ blank_issues_enabled: false contact_links: - - name: gprMax support + - name: "📚 Read docs" + url: https://docs.gprmax.com/en/devel/ + about: Find your solution from our documenations + - name: "😊 gprMax support" url: https://groups.google.com/g/gprmax about: | Please only file issues here that you believe represent actual bugs or feature requests for the gprMax software. - If you're having general trouble with using gprMax, please visit our help center to get support. + If you're having general trouble with using gprMax, please visit our help center to get support. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml index 905acd15..11e5790c 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yaml +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -1,4 +1,4 @@ -name: Feature request +name: "🌟Feature request" description: Suggest an idea for gprMax software labels: ["feature-request"] body: @@ -17,4 +17,4 @@ body: id: context attributes: label: Additional context - description: Add any other context about the feature request here. + description: Add any other context about the feature request here. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..a575049f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,51 @@ +# 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 +3. Make the changes you want to make +4. Run the following command before you commit your changes to ensure that your code is formatted correctly: + +``` +pre-commit run --all-files +``` + +5. Commit your changes locally as you progress +6. Push your local branch to your fork +7. 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.