From b11d559efd21d15fd7597962ae13ef7cecf0da70 Mon Sep 17 00:00:00 2001 From: Shahzeb Siddiqui Date: Mon, 10 Jul 2023 16:28:00 -0400 Subject: [PATCH 1/4] add section for best practices for creating a pull request. Remove a few sections from General Tips --- docs/contributing/code_contribution_guide.rst | 36 +++++++++++++------ 1 file changed, 26 insertions(+), 10 deletions(-) diff --git a/docs/contributing/code_contribution_guide.rst b/docs/contributing/code_contribution_guide.rst index 3f4ceacc4..93f9dce29 100644 --- a/docs/contributing/code_contribution_guide.rst +++ b/docs/contributing/code_contribution_guide.rst @@ -90,6 +90,24 @@ branch which is your feature branch pushed at your fork. .. note:: Do not push to ``master`` or ``devel`` branch on your fork or upstream. +Best Practices when creating Pull Request +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- It's good practice to link PR to an issue during commit message. Such as +stating ``Fix #132`` for fixing issue 132. + +- Please create a meaningful title and PR description to help outline +your proposed changes. + +- Assign PR to yourself when creating the issue. You should @ mention (`@shahzebsiddiqui `_) +the project maintainers to get their attention. + +- If your PR is not ready for review, please add ``WIP:`` to your PR title to indicate it's a work in progress +and make it a draft PR. This will prevent maintainers from reviewing your PR until it's ready. + +- Check the CI checks corresponding to your PR to ensure all checks are passed. If you see any failures, please fix them especially +regression test failures. + Pull Request Review -------------------- @@ -143,26 +161,24 @@ Once you have synced your branch push your changes and check if file conflicts a General Tips ------------- -1. It's good practice to link PR to an issue during commit message. Such as -stating ``Fix #132`` for fixing issue 132. - -2. If you have an issue, ask your question in slack before reporting issue. If +- If you have an issue, ask your question in slack before reporting issue. If your issue is not resolved check any open issues for resolution before creating a new issue. -3. For new features or significant code refactor please notify maintainers and +- For new features or significant code refactor please notify maintainers and open an issue before working on task to keep everyone informed. -4. If you open an issue, please respond back during discussion, if there is no +- If you open an issue, please respond back during discussion, if there is no activity the issue will be closed. -5. Please refrain from opening duplicate issue, check if there is an existing -issue addressing similar problem, instead you can participate in discussion in -the issue or contact appropriate individuals directly in slack. +- Please refrain from opening duplicate issue, check if there is an existing +issue addressing similar problem. You can ask questions in slack to report your issue +or contact project maintainers. -6. There should not be any branches other than ``master`` or ``devel``. Feature +- There should not be any branches other than ``master`` or ``devel``. Feature branches should be pushed to your fork and not to origin. + .. _black_hook: Configuring Black Pre-Commit Hook From 7e5673427e8257b94eaa2cebaa986c139a2a8b01 Mon Sep 17 00:00:00 2001 From: Shahzeb Siddiqui Date: Mon, 10 Jul 2023 16:36:34 -0400 Subject: [PATCH 2/4] fix issue with bullet points need to be on single line --- docs/contributing/code_contribution_guide.rst | 33 ++++++------------- 1 file changed, 10 insertions(+), 23 deletions(-) diff --git a/docs/contributing/code_contribution_guide.rst b/docs/contributing/code_contribution_guide.rst index 93f9dce29..3b8d15da1 100644 --- a/docs/contributing/code_contribution_guide.rst +++ b/docs/contributing/code_contribution_guide.rst @@ -93,20 +93,15 @@ branch which is your feature branch pushed at your fork. Best Practices when creating Pull Request ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- It's good practice to link PR to an issue during commit message. Such as -stating ``Fix #132`` for fixing issue 132. +- It's good practice to link PR to an issue during commit message. Such as stating ``Fix #132`` for fixing issue 132. -- Please create a meaningful title and PR description to help outline -your proposed changes. +- Please create a meaningful title and PR description to help outline your proposed changes. -- Assign PR to yourself when creating the issue. You should @ mention (`@shahzebsiddiqui `_) -the project maintainers to get their attention. +- Assign PR to yourself when creating the issue. You should @ mention (`@shahzebsiddiqui `_) the project maintainers to get their attention. -- If your PR is not ready for review, please add ``WIP:`` to your PR title to indicate it's a work in progress -and make it a draft PR. This will prevent maintainers from reviewing your PR until it's ready. +- If your PR is not ready for review, please add ``WIP:`` to your PR title to indicate it's a work in progress and make it a draft PR. This will prevent maintainers from reviewing your PR until it's ready. -- Check the CI checks corresponding to your PR to ensure all checks are passed. If you see any failures, please fix them especially -regression test failures. +- Check the CI checks corresponding to your PR to ensure all checks are passed. If you see any failures, please fix them especially regression test failures. Pull Request Review -------------------- @@ -161,23 +156,15 @@ Once you have synced your branch push your changes and check if file conflicts a General Tips ------------- -- If you have an issue, ask your question in slack before reporting issue. If -your issue is not resolved check any open issues for resolution before creating -a new issue. +- If you have an issue, ask your question in slack before reporting issue. If your issue is not resolved check any open issues for resolution before creating a new issue. -- For new features or significant code refactor please notify maintainers and -open an issue before working on task to keep everyone informed. +- For new features or significant code refactor please notify maintainers and open an issue before working on task to keep everyone informed. -- If you open an issue, please respond back during discussion, if there is no -activity the issue will be closed. +- If you open an issue, please respond back during discussion, if there is no activity the issue will be closed. -- Please refrain from opening duplicate issue, check if there is an existing -issue addressing similar problem. You can ask questions in slack to report your issue -or contact project maintainers. - -- There should not be any branches other than ``master`` or ``devel``. Feature -branches should be pushed to your fork and not to origin. +- Please refrain from opening duplicate issue, check if there is an existing issue addressing similar problem. You can ask questions in slack to report your issue or contact project maintainers. +- There should not be any branches other than ``master`` or ``devel``. Feature branches should be pushed to your fork and not to origin. .. _black_hook: From 34e5bd8350470011b3c61f89c0fdab4d8594f1b2 Mon Sep 17 00:00:00 2001 From: Shahzeb Siddiqui Date: Tue, 11 Jul 2023 16:34:16 -0400 Subject: [PATCH 3/4] minor updates to few sentences --- docs/contributing/code_contribution_guide.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/contributing/code_contribution_guide.rst b/docs/contributing/code_contribution_guide.rst index 3b8d15da1..26413fc2c 100644 --- a/docs/contributing/code_contribution_guide.rst +++ b/docs/contributing/code_contribution_guide.rst @@ -90,7 +90,7 @@ branch which is your feature branch pushed at your fork. .. note:: Do not push to ``master`` or ``devel`` branch on your fork or upstream. -Best Practices when creating Pull Request +Best Practices When Creating Pull Request ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - It's good practice to link PR to an issue during commit message. Such as stating ``Fix #132`` for fixing issue 132. @@ -99,7 +99,7 @@ Best Practices when creating Pull Request - Assign PR to yourself when creating the issue. You should @ mention (`@shahzebsiddiqui `_) the project maintainers to get their attention. -- If your PR is not ready for review, please add ``WIP:`` to your PR title to indicate it's a work in progress and make it a draft PR. This will prevent maintainers from reviewing your PR until it's ready. +- If your PR is not ready for review, please add ``WIP:`` to your PR title to indicate that it's a work in progress and make it a draft PR. This will prevent maintainers from reviewing your PR until it's ready. - Check the CI checks corresponding to your PR to ensure all checks are passed. If you see any failures, please fix them especially regression test failures. @@ -156,13 +156,13 @@ Once you have synced your branch push your changes and check if file conflicts a General Tips ------------- -- If you have an issue, ask your question in slack before reporting issue. If your issue is not resolved check any open issues for resolution before creating a new issue. +- If you have an issue, ask your question in slack before reporting the issue. If your issue is not resolved check any open issues for resolution before creating a new issue. -- For new features or significant code refactor please notify maintainers and open an issue before working on task to keep everyone informed. +- For new features or significant code refactors, please notify maintainers and open an issue before working on task to keep everyone informed. -- If you open an issue, please respond back during discussion, if there is no activity the issue will be closed. +- If you open an issue, please respond back during the discussion, if there is no activity the issue will be closed. -- Please refrain from opening duplicate issue, check if there is an existing issue addressing similar problem. You can ask questions in slack to report your issue or contact project maintainers. +- Please refrain from a opening duplicate issue, check if there is an existing issue addressing similar problems. You can ask questions in slack to report your issue or contact project maintainers. - There should not be any branches other than ``master`` or ``devel``. Feature branches should be pushed to your fork and not to origin. From f215ee12509472274df161f66ff1783586e9d088 Mon Sep 17 00:00:00 2001 From: Shahzeb Siddiqui Date: Wed, 12 Jul 2023 13:57:42 -0400 Subject: [PATCH 4/4] rephrase wording in bullet point --- docs/contributing/code_contribution_guide.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/code_contribution_guide.rst b/docs/contributing/code_contribution_guide.rst index 26413fc2c..9146a4b23 100644 --- a/docs/contributing/code_contribution_guide.rst +++ b/docs/contributing/code_contribution_guide.rst @@ -162,7 +162,7 @@ General Tips - If you open an issue, please respond back during the discussion, if there is no activity the issue will be closed. -- Please refrain from a opening duplicate issue, check if there is an existing issue addressing similar problems. You can ask questions in slack to report your issue or contact project maintainers. +- Please refrain from opening a duplicate issue, check if there is an existing issue addressing similar problems. You can ask questions in slack to report your issue or contact project maintainers. - There should not be any branches other than ``master`` or ``devel``. Feature branches should be pushed to your fork and not to origin.