From 0786ed2d5ab283055259e6d072145a5a5c720786 Mon Sep 17 00:00:00 2001 From: Sai-Suraj-27 Date: Sun, 6 Aug 2023 18:32:23 +0530 Subject: [PATCH 1/4] Prepared a basic contribution_guide for gprMax. --- CONTRIBUTING_GUIDE.md | 45 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 CONTRIBUTING_GUIDE.md diff --git a/CONTRIBUTING_GUIDE.md b/CONTRIBUTING_GUIDE.md new file mode 100644 index 00000000..069c1eec --- /dev/null +++ b/CONTRIBUTING_GUIDE.md @@ -0,0 +1,45 @@ +# Contributing to gprMax + +Thank you for your interest in contributing to gprMax, we really appreciate your time and effort! + +## How can you help us? + +* Report a bug +* Improve documentation +* 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. From a2101bc431da87aa347be7489f549ad274985546 Mon Sep 17 00:00:00 2001 From: Sai-Suraj-27 Date: Sun, 6 Aug 2023 18:40:37 +0530 Subject: [PATCH 2/4] Added link to docs, renamed the file. --- CONTRIBUTING_GUIDE.md => CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename CONTRIBUTING_GUIDE.md => CONTRIBUTING.md (93%) diff --git a/CONTRIBUTING_GUIDE.md b/CONTRIBUTING.md similarity index 93% rename from CONTRIBUTING_GUIDE.md rename to CONTRIBUTING.md index 069c1eec..f68ebbd8 100644 --- a/CONTRIBUTING_GUIDE.md +++ b/CONTRIBUTING.md @@ -5,7 +5,7 @@ Thank you for your interest in contributing to gprMax, we really appreciate your ## How can you help us? * Report a bug -* Improve documentation +* Improve our [documentation](https://docs.gprmax.com/en/devel/) * Submit a bug fix * Propose new features * Discuss the code implementation From a75781f25aa2e46fdbd2d20475d1d541bfbaf2f8 Mon Sep 17 00:00:00 2001 From: Sai-Suraj-27 Date: Thu, 10 Aug 2023 11:58:16 +0530 Subject: [PATCH 3/4] Added few more points to the contribution_guide. --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f68ebbd8..a575049f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,6 +2,12 @@ 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 From fbe7b2865827b22714aabb4061f9e00a78fc07b9 Mon Sep 17 00:00:00 2001 From: Sai-Suraj-27 Date: Mon, 14 Aug 2023 14:37:43 +0530 Subject: [PATCH 4/4] Updated the issue templates to add a 'Read the docs' section. --- .github/ISSUE_TEMPLATE/bug_report.yaml | 4 ++-- .github/ISSUE_TEMPLATE/config.yaml | 7 +++++-- .github/ISSUE_TEMPLATE/feature_request.yaml | 4 ++-- 3 files changed, 9 insertions(+), 6 deletions(-) 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.