Add Pull Request Template File

[romsi]

Goals ⚽

Enforcing standardisation, reducing missing information for reviewers and encourage high-quality pull requests.

Inspiration 💡

• Alamofire PULL_REQUEST_TEMPLATE.md

[damienfraud]

I like this first template. I think it would be nice to also have a scrip section to checkout bigger pull requests. I think changelogs are really important too but maybe not in the case of creating/editing documents. What do you think? Or maybe we should setup different templates regarding the type of content that is being reviewed?

[romsi]

As long as we don't need to build a project, I feel it's a bit overkilled.

[damienfraud]

@romsi I agree. However, I still believe that at least having checkout scripts inside PR is great. I truly believe that even for documentation only, having it makes it easier for new contributors and would push them to contribute more easily.

Imagine that you find a new GitHub project that looks really interesting to you. You take a look at the project, find that an important information is missing and think it would be nice to add it to the README. You go to the pull requests and see one that treats the matter you would like to contribute to. You go to the pull request and find out that there is a script for you to checkout easily and right away that project you have never worked on before!

I feel like this is important in the way that everything is here to make you want to contribute, having scripts can avoid to make excuses up for not contributing to the project. Everything is made easy for you.

To me having scripts inside a PR is like having a ready to contribute task.

[damienfraud]

We should also discuss the format of PR titles. But again, maybe this should be done in a CONTRIBUTING file. In that case, I will create one as soon as I find time and create a pull request for it.

[damienfraud]

I wanted to add another comment also just to say that I really like the use of emojis that quickly give a visual context of the content. 👍 🙌

[romsi]

@damienfraud I believe that ci tools should do it. CI tools must ensure that what has been done didn't break anything. During code review we should do only:

Once a Pull Request has been opened, the person or team reviewing your changes may have questions or comments. Perhaps the coding style doesn't match project guidelines, the change is missing unit tests, or maybe everything looks great and props are in order. Pull Requests are designed to encourage and capture this type of conversation.

[romsi]

We should wait for approval nshift/github-guidelines#3 and then update the pull request template.