Merge pull request #315 from smoia/doc/reviews

Add documentation for reviewers and a checklist for PRs

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,7 +1,37 @@
+<!-- Write all of the issues that are linked to this pull request. -->
+<!-- If this PR is enough to close them you can write something like "Closes #314 and closes #42" -->
+<!-- If you just want to reference them without closing them, you can add something like "References #112" -->
 Closes #
 
-## Proposed Changes
+<!-- Add a short description of the PR content here-->
+
 
+## Proposed Changes
+<!-- List major points of changes here, so that the reviewers can have a bit more context while looking at your work! -->
   -
   -
-  -
+  -
+
+## Change Type
+<!-- Indicate the type of change you think your pull request is -->
+- [ ] `bugfix` (+0.0.1)
+- [ ] `minor` (+0.1.0)
+- [ ] `major`  (+1.0.0)
+- [ ] `internal` (no version update)
+- [ ] `documentation` (no version update)
+
+## Checklist before review
+<!-- If this section is not clear, please read this part of the docs: https://phys2bids.readthedocs.io/en/latest/contributorfile.html#pr -->
+<!-- You're invited to open a draft PR ASAP, but before marking it "ready for review", check that you have done the following: -->
+- [ ] I added everything I wanted to add to this PR.
+- [ ] \[Code or tests only\] I wrote/updated the necessary docstrings.
+- [ ] \[Code or tests only\] I ran and passed tests locally.
+- [ ] \[Documentation only\] I built the docs locally.
+- [ ] My contribution is harmonious with the rest of the code: I'm not introducing repetitions.
+- [ ] My code respects the adopted style, especially linting conventions.
+- [ ] The title of this PR is explanatory on its own, enough to be understood as part of a changelog.
+- [ ] I added or indicated the right labels.
+<!-- If relevant, you can add a milestone label or indicate an ideal timeline for this PR, including whether the progress of this PR is linked to other PRs being completed before or after it. -->
+- [ ] I added information regarding the timeline of completion for this PR.
+<!-- If you want, you can ask for reviews on a draft PR -->
+- [ ] Please, comment on my PR while it's a draft and give me feedback on the development!

docs/contributing.rst

@@ -9,12 +9,11 @@ First of all: thank you!
 Contributions can be made in different ways, not only code!
 As we follow the `all-contributors`_ specification, any contribution will be recognised accordingly.
 
-The first thing you might want to do, is to have a look at the `contributor guide <contributorfile.html>`_ page as well as the `code of conduct <conduct.html>`_.
+Follow these steps to get started:
 
-The second thing is to check you have ``git`` and ``pip`` installed in your system.
-
-The third thing is to install ``phys2bids`` as a developer.
-This will let you run the program with the latest modification, without requiring you to re-install it every time.
+1. Have a look at the `contributor guide <contributorfile.html>`_ page as well as the `code of conduct <conduct.html>`_.
+2. Make sure that you have a GitHub account. You can set up a `free GitHub account <https://github.com/>`_; here are some `instructions <https://help.github.com/articles/signing-up-for-a-new-github-account>`_.
+3. If you intend to contribute code and/or use the ``physiopy`` packages in any way, check that you have ``git`` and ``pip`` installed on your system. Then install ``phys2bids`` as a developer. This will let you run the program with the latest modifications, without requiring to re-install it every time.
 
 .. _`all-contributors`: https://github.com/all-contributors/all-contributors