search

nikitaeverywhere / react-xmasonry

Simple, minimalistic and featured native masonry layout for React JS.
https://zitros.github.io/react-xmasonry
MIT License
91 stars 12 forks source link

Issue template and Pull Request template added #11

Closed daguttierrez closed 6 years ago

daguttierrez commented 6 years ago

Templates added

Description

Additional Info: https://github.com/blog/2111-issue-and-pull-request-templates

nikitaeverywhere commented 6 years ago

Hi Diego! :) Thanks for finding a motivation to contribute to my project, I really appreciate this!

Usually PR/Issue templates are very specific from one project to another, and I think this case is not an exception. The templates you uploaded seem to be copied from somewhere, at least at the first glance.

There are a couple of things in your templates which I would consider to re-think:

Issue template

  1. OS version -> Browser version
  2. What's Butter in about tab?
  3. Screenshots can be mentioned without a link to a specific software/service which do screenshots.

PR template

  1. I think Migrations is odd.
  2. Related PRs/branches almost never happen as well, the project is not so big. Those who work "on big parts" already know how to design a PR descriptions.
  3. Todos, as well, odd here. No one will accept PRs that add more work.
  4. Impacted areas are always obvious.
  5. No /CONTRIBUTING.md, but the link to file exists.

And I think writing a lot of requirements usually repels people who just want to contribute a tiny fix :) I have never met PRs that I could not understand or discuss because of the lack of the information.

Please, let me know what do you think.

nikitaeverywhere commented 6 years ago

Haha, your PR triggered a Codacy re-ranking on the repository and now it's C 😃

daguttierrez commented 6 years ago

Hey! Yeah it is jut an starting point, I just wanted your thoughts about it, I'll start adjusting what you just mentioned and start improving the templates.

nikitaeverywhere commented 6 years ago

@daguttierrez, check for example this template I created in another project. Try to keep it short and friendly if possible :)

nikitaeverywhere commented 6 years ago

I am closing this PR due to inactivity. @daguttierrez, let me decide this time about templates by myself. I know you try to do good things but usually templates are something the owners of the repository decide to add theirselves (like project description, etc).