Skip to content

Commit 1b559a9

Browse files
authored
Merge pull request Qiskit#535 from abdonrd/changelog
Update changelog to the new format
2 parents eca566c + 53565d3 commit 1b559a9

File tree

2 files changed

+389
-47
lines changed

2 files changed

+389
-47
lines changed

.github/CONTRIBUTING.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -248,6 +248,27 @@ you are ready to start coding (yay!). We have two options here:
248248
will remove the **[WIP]** prefix from the description once the PR is ready
249249
to merge.
250250

251+
Pull request checklist
252+
""""""""""""""""""""""
253+
254+
When submitting a pull request and you feel it is ready for review, please
255+
double check that:
256+
257+
* the code follows the code style of the project. For convenience, you can
258+
execute ``make style`` and ``make lint`` locally, which will print potential
259+
style warnings and fixes.
260+
* the documentation has been updated accordingly. In particular, if a function
261+
or class has been modified during the PR, please update the docstring
262+
accordingly.
263+
* your contribution passes the existing tests, and if developing a new feature,
264+
that you have added new tests that cover those changes.
265+
* you add a new line to the ``CHANGELOG.rst`` file, in the ``UNRELEASED``
266+
section, with the title of your pull request and its identifier (for example,
267+
"``Replace OldComponent with FluxCapacitor (#123)``".
268+
269+
Commit messages
270+
"""""""""""""""
271+
251272
Please follow the next rules for the commit messages:
252273

253274
- It should include a reference to the issue ID in the first line of the commit,

0 commit comments

Comments
 (0)