Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Use checkboxes as bullet points for the PR review checklists #15349

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

Merged
merged 1 commit into from
Apr 13, 2020
Merged

Use checkboxes as bullet points for the PR review checklists #15349

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions doc/devel/coding_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
.. _pr-guidelines:

.. raw:: html

<style>
.checklist { list-style: none; padding: 0; margin: 0; }
.checklist li { margin-left: 24px; padding-left: 23px; margin-right: 6px; }
.checklist li:before { content: "\2610\2001"; margin-left: -24px; }
.checklist li p {display: inline; }
</style>

***********************
Pull request guidelines
***********************
Expand All @@ -23,6 +32,8 @@ Summary for PR authors

When making a PR, pay attention to:

.. rst-class:: checklist

* :ref:`Target the master branch <pr-branch-selection>`.
* Adhere to the :ref:`coding_guidelines`.
* Update the :ref:`documentation <pr-documentation>` if necessary.
Expand Down Expand Up @@ -53,13 +64,17 @@ Summary for PR reviewers

Content topics:

.. rst-class:: checklist

* Is the feature / bugfix reasonable?
* Does the PR conform with the :ref:`coding_guidelines`?
* Is the :ref:`documentation <pr-documentation>` (docstrings, examples,
what's new, API changes) updated?

Organizational topics:

.. rst-class:: checklist

* Make sure all :ref:`automated tests <pr-automated-tests>` pass.
* The PR should :ref:`target the master branch <pr-branch-selection>`.
* Tag with descriptive :ref:`labels <pr-labels>`.
Expand Down