Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add subsection 'Best Practices when creating Pull Request' #1531

Merged
merged 4 commits into from
Jul 12, 2023
Merged

add subsection 'Best Practices when creating Pull Request' #1531

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b11d559
add section for best practices for creating a pull request. Remove a …
shahzebsiddiqui Jul 10, 2023
7e56734
fix issue with bullet points need to be on single line
shahzebsiddiqui Jul 10, 2023
34e5bd8
minor updates to few sentences
shahzebsiddiqui Jul 11, 2023
f215ee1
rephrase wording in bullet point
shahzebsiddiqui Jul 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 18 additions & 15 deletions docs/contributing/code_contribution_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,19 @@ 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 <https://github.com/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 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.
szuananwar marked this conversation as resolved.
Show resolved Hide resolved

Pull Request Review
--------------------

Expand Down Expand Up @@ -143,25 +156,15 @@ 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
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.

3. 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.

4. 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.

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 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.
shahzebsiddiqui marked this conversation as resolved.
Show resolved Hide resolved

6. There should not be any branches other than ``master`` or ``devel``. Feature
branches should be pushed to your fork and not to origin.
- 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:

Expand Down
Loading