#269: Update contributing and add pr issue templates #355
Conversation
|
Hey @satwikkansal . I've decided to prepare templates and update CONTRIBUTING before creating small issues for fixing |
| * [ ] Have you checked to ensure there aren't other open [Issues](../../../issues) for the same update/change? | ||
| * [ ] Have you added an explanation of what your changes do and why you'd like us to include them? |
There was a problem hiding this comment.
Let's rephrase this
Let's add a section, name Explanation (optional)
and a question asking Is this snippet similar to any of the existing snippets in the project or issues.
|
|
||
| ## Checklist before requesting a review | ||
|
|
||
| - [ ] Have you checked to ensure there aren't other open [Pull Requests](../../../pulls) for the same update/change? |
| - [ ] Have you checked to ensure there aren't other open [Pull Requests](../../../pulls) for the same update/change? | ||
| - [ ] Have you followed the guidelines in [CONTRIBUTING.md](../../CONTRIBUTING.md)? | ||
| <!--- Question: Should we add pre-commit hook and CI check for commit messages? For example, https://github.com/compilerla/conventional-pre-commit--> | ||
| - [ ] Do your commit messages follow [guidelines](https://www.conventionalcommits.org/en/v1.0.0/)? |
| Contributions are made to this repo via Issues and Pull Requests (PRs). A few general guidelines that cover both: | ||
|
|
||
| - Search for existing Issues and PRs before creating your own. | ||
| - We work hard to makes sure issues are handled in a timely manner but, depending on the impact, it could take a while to investigate the root cause. A friendly ping in the comment thread to the submitter or a contributor can help draw attention if your issue is blocking. |
| All kinds of patches are welcome. Feel free to even suggest some catchy and funny titles for the existing Examples. The goal is to make this collection as interesting to read as possible. Here are a few ways through which you can contribute, | ||
|
|
||
| - If you are interested in translating the project to another language (some people have done that in the past), please feel free to open up an issue, and let me know if you need any kind of help. | ||
| - If you are interested in translating the project to another language, please feel free to open up an issue using `translation` template, and let me know if you need any kind of help. |
There was a problem hiding this comment.
Sorry I might have forgotted, Is the translation template already merged.
There was a problem hiding this comment.
No, it stored in my local git stash for now, I will add it to current PR a bit later, just waited for your comments about the whole PR
@nifadyev just did and left some comments, the overarching theme is that we shouldn't make it time consuming for a new contributor to set up an issue or open a PR, as it demotivates them to share something that might be of interest to us. Once they create an issue we can ask for extra details then, that approach has better conversion :) |
100%. The problem is to find the balance between ease of creating issue/PR and avoiding duplicates and extra work for reviewers/maintainers. Let's start as you suggested and then adopt if necessary. |
nifadyev
force-pushed
the
#269/update-contributing-and-add-pr-issue-templates
branch
from
57dac9c
to
347f0df
Compare
|
Hey @satwikkansal, I've fixed your remarks and added PR and issue templates for bug reports and translations |
|
|
||
| * [ ] Have you checked to ensure there aren't other open [Issues](../../../issues) for the same update/change? | ||
| * [ ] Have you checked that this snippet is not similar to any of the existing snippets? | ||
| * [ ] Have you added an `Explanation` section? It shall include the reasons of changes and why you'd like us to include them |
There was a problem hiding this comment.
let's mark the explanation section optional, sometime people come to us without having exact explanation
|
@nifadyev, thanks! One minor comment, everything else looks good |
…mplates - Add issue templates for bugs, translations and new snippets - Add PR templates for general purpose, new snippets and translations
nifadyev
force-pushed
the
#269/update-contributing-and-add-pr-issue-templates
branch
from
347f0df
to
cc704ce
Compare
|
Thanks, @satwikkansal , comment about |
|
Thanks @nifadyev, I merged! |
Fixes #269
Checklist before requesting a review
Request review from @satwikkansal