From c27adae765276d9398e7fd077122dcbfea3c176b Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Fri, 12 Dec 2025 10:20:09 +0000 Subject: [PATCH 1/8] add pull request template --- .github/pull_request_template.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..2384f0fea --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,24 @@ +_Thanks for contributing to Gambit! Before you submitting or reviewing a pull request, check out our [guidelines for contributing](https://gambitproject.readthedocs.io/en/latest/developer.contributing.html)._ + +_The person submitting the PR should update the headers below, before marking the PR as ready for review and assigning reviewers._ + +### Issues closed by this PR + +_Add any issues that are being closed by this PR to the list. Use "Closes" or [another keyword](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) followed by the issue number._ + +- Closes #ISSUE_NUMBER + +### Description of the changes in this PR + +_Update the description of the changes made in this PR. You can delete this section if the changes are already fully described in the linked issues._ + +This PR ... + +### How to review this PR + +_The gambit repository contains source code and documentation for several different components. Explain how a reviewer should approach reviewing the specific changes made in this PR._ + +_For example, you might include instructions like:_ +- _"Review code changes and ensure tests cover edge cases"_ +- _"Rebuild the GUI from this branch, then test features X, Y, Z work as expected"_ +- _"Click the link to the documentation page and sense check by reading"_ From 8910bd8cc4aaef0c0a74b9f82e8e4fc8e0008822 Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Fri, 12 Dec 2025 10:25:37 +0000 Subject: [PATCH 2/8] branch naming convention --- doc/developer.contributing.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/developer.contributing.rst b/doc/developer.contributing.rst index 0abab8744..df914f832 100644 --- a/doc/developer.contributing.rst +++ b/doc/developer.contributing.rst @@ -63,9 +63,9 @@ version. Having `pre-commit` installed is recommended as it runs many of the same checks that are automatically conducted on any pull request. Every time you commit, it will automatically fix some issues and highlight others for manual adjustment. -5. Create a new branch for your changes :: +5. Create a new branch for your changes. It's good practice to either give the branch a descriptive name or directly reference an issue number :: - git checkout -b feature/your-feature-name + git checkout -b feature/issue-number 6. Make your changes. :: @@ -78,7 +78,7 @@ version. 7. Push your changes to your fork or branch :: - git push origin feature/your-feature-name + git push origin feature/issue-number 8. Open a pull request on GitHub to the master branch of the upstream repository, describing your changes and linking to any relevant issues. 9. Core developers will review your changes, provide feedback, and merge them into the master branch if they meet the project's standards. From 161650dbc537fece97b2ee06169a7a11579bcf7c Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Fri, 12 Dec 2025 10:31:53 +0000 Subject: [PATCH 3/8] update pull request suggestions in contributing guide --- doc/developer.contributing.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/doc/developer.contributing.rst b/doc/developer.contributing.rst index df914f832..719c580f8 100644 --- a/doc/developer.contributing.rst +++ b/doc/developer.contributing.rst @@ -80,7 +80,15 @@ version. git push origin feature/issue-number -8. Open a pull request on GitHub to the master branch of the upstream repository, describing your changes and linking to any relevant issues. +8. Open a pull request on GitHub to the master branch of the upstream repository. Ensure your pull request: + +- Links to any relevant issues. +- Includes a clear description of the changes made. +- Explains how a reviewer can test the changes. + +.. note:: + It's good practice to open a draft pull request early in the development process to facilitate discussion and feedback. + 9. Core developers will review your changes, provide feedback, and merge them into the master branch if they meet the project's standards. Testing your changes From 182c73db102c89775840eb3c27bcbb45aab4b839 Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Fri, 12 Dec 2025 10:33:09 +0000 Subject: [PATCH 4/8] update note --- doc/developer.contributing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/developer.contributing.rst b/doc/developer.contributing.rst index 719c580f8..4758c1132 100644 --- a/doc/developer.contributing.rst +++ b/doc/developer.contributing.rst @@ -87,7 +87,7 @@ version. - Explains how a reviewer can test the changes. .. note:: - It's good practice to open a draft pull request early in the development process to facilitate discussion and feedback. + It's good practice to open a draft pull request early in the development process to facilitate discussion and feedback, ensure there are no merge conflicts, and allow for continuous integration testing via GitHub Actions. 9. Core developers will review your changes, provide feedback, and merge them into the master branch if they meet the project's standards. From b40be6fe6484da2f63545bb0b9679f5e19a1ad14 Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Fri, 12 Dec 2025 10:41:00 +0000 Subject: [PATCH 5/8] fix bullet indentation --- doc/developer.contributing.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/developer.contributing.rst b/doc/developer.contributing.rst index 4758c1132..12d2971ee 100644 --- a/doc/developer.contributing.rst +++ b/doc/developer.contributing.rst @@ -37,8 +37,8 @@ version. 1. To get started contributing code in the `Gambit GitHub repo `__, do one of the following: -- Core developers: request contributor access from one of the `team `__ -- External contributors: fork the repository on GitHub. + - Core developers: request contributor access from one of the `team `__ + - External contributors: fork the repository on GitHub. 2. Clone the repository to your local machine :: @@ -82,12 +82,12 @@ version. 8. Open a pull request on GitHub to the master branch of the upstream repository. Ensure your pull request: -- Links to any relevant issues. -- Includes a clear description of the changes made. -- Explains how a reviewer can test the changes. + - Links to any relevant issues. + - Includes a clear description of the changes made. + - Explains how a reviewer can test the changes. -.. note:: - It's good practice to open a draft pull request early in the development process to facilitate discussion and feedback, ensure there are no merge conflicts, and allow for continuous integration testing via GitHub Actions. + .. note:: + It's good practice to open a draft pull request early in the development process to facilitate discussion and feedback, ensure there are no merge conflicts, and allow for continuous integration testing via GitHub Actions. 9. Core developers will review your changes, provide feedback, and merge them into the master branch if they meet the project's standards. From 78d570808cac26b98937569657c4ec6fce3d13b1 Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Fri, 12 Dec 2025 10:43:07 +0000 Subject: [PATCH 6/8] add note to delete branch after merging pull request --- doc/developer.contributing.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/developer.contributing.rst b/doc/developer.contributing.rst index 12d2971ee..0f2ea1ba4 100644 --- a/doc/developer.contributing.rst +++ b/doc/developer.contributing.rst @@ -91,6 +91,8 @@ version. 9. Core developers will review your changes, provide feedback, and merge them into the master branch if they meet the project's standards. +10. Once your pull request is merged, delete your branch on GitHub (a button should appear to do this automatically). + Testing your changes -------------------- From 550af44d3304df4ad50dc01a003b98d76b8ceb83 Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Fri, 12 Dec 2025 10:44:39 +0000 Subject: [PATCH 7/8] mention title --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 2384f0fea..b4e021528 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,6 +1,6 @@ _Thanks for contributing to Gambit! Before you submitting or reviewing a pull request, check out our [guidelines for contributing](https://gambitproject.readthedocs.io/en/latest/developer.contributing.html)._ -_The person submitting the PR should update the headers below, before marking the PR as ready for review and assigning reviewers._ +_The person submitting the PR should ensure it has an informative title and update the headers below, before marking the PR as ready for review and assigning reviewers._ ### Issues closed by this PR From 07c447e0ee403f13681411460dbfe285589058d4 Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Fri, 12 Dec 2025 10:45:18 +0000 Subject: [PATCH 8/8] title --- doc/developer.contributing.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/developer.contributing.rst b/doc/developer.contributing.rst index 0f2ea1ba4..f86939850 100644 --- a/doc/developer.contributing.rst +++ b/doc/developer.contributing.rst @@ -82,6 +82,7 @@ version. 8. Open a pull request on GitHub to the master branch of the upstream repository. Ensure your pull request: + - Has an informative title. - Links to any relevant issues. - Includes a clear description of the changes made. - Explains how a reviewer can test the changes.