Include checklist in pull request template

[eddybrando]

This is a follow up on the PR that introduced a pull request template.

As discussed in the PR comments, the initial idea of including a checklist in the template has some arguments for and against.

On the one hand, ideally, having a checklist makes the contributor think again about our best practices on each submitted pull request.

On the other hand, we already have a place were we document our best practices, and that is a wider accepted standard: the CONTRIBUTING file.

Also, if a contributor sees the checklist too often, maybe the'll start just checking the boxes without really reading them. But the same could be true for the information in the CONTRIBUTING file.

My original idea was to add only a couple of checkboxes for the most critical checks in the attempt to push for the adoption of better practices.

---

Original proposal

All of the following must be checked:

• I have tested my changes.
• I comply with the contributing guidelines.

For each of the following sections, at least one must be checked:

• Code style
  • The changes follow the code style of this project, or
  • The changes are not related to code.
• Documentation
  • The changes don't required updating the documentation, or
  • The documentation has been updated, or
  • An issue has been created to track the changes to the documentation.
• Testing
  • The changes don't require updating or creating tests, or
  • Relevant tests have been updated or created, or
  • An issue has been created to track updating or creating relevant testing.

---

As @abdonrd pointed out, using checklists results in a confusing UI since GitHub thinks that all checkboxes need to be marked for the PR to be ready / completed, which might lead to reviewers not starting the review even though it's indeed ready.

Later, @techtolentino proposed a summarised version without the checkboxes.

---

@techtolentino's summarised proposal

Checklist:

• Did you follow the contributing guidelines
• Be sure to test your code, otherwise open a new issue to handle testing
• Please update any relevant documentation that is needed

---

I like this short proposal as well.

Personally, I believe that having some recurrent reminders might be helpful, at least for now, until we're at a point were we have a more mature process to keep our testing, coding style and documentation well checked and updated constantly.

It's true that this information for contributions is also available somewhere else, but I don't know how often one visits the CONTRIBUTING page.

Similarly, it's true I know I need to drink more water, but having an app remind me helps me build a habit. 💧