-
Notifications
You must be signed in to change notification settings - Fork 51
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add contribution guideline and issue templating to the repository #1107
Comments
@metemaddar: maybe you can take the lead on this one. And we can support here :) |
Thanks for assign this valuable and attractive task also to me while it gives me great sight over the issues/PR process. Add templates for PRs alsoWe can also have issue templates for PRs which also have guidelines to auto-close related issues, summaries, and more. (Using this guideline) For blank templateAs I found in the tutorials, We will always have a button under the whole templates to create a blank issue. However maybe it is good to create a blank template in order to have big button for it. Although not creating a blank template may lead the creator to first focus on specific templates first. Example issue template repositoryFound this great repository which has examples for technical aspects to create issue/PR templates: https://github.com/stevemao/github-issue-templates More linksI found some great videos about issue templates:
Also there is a good guideline to create tasks. However I think we have most of them, but I was thinking that if we could have external guideline links at template, it would be a good help in some situations. |
Thanks a lot, @metemaddar for this great research! All of it is interesting. I would propose that you could maybe check what would be needed from your opinion. I mean we can start small with some templates for the most common issues and then expand it in the future. Also concerning PRs, it would be good to have a template. Some automation like autoclosing issue would also be interesting so maybe we could check which workflows would be suitable for this. |
I'm very agree about starting with simple templates as they can better fit to our needs in the future.
I think it's not bad to have both forms and templates for a topic category. But however it can make issue creation crowded. And about screenshotsIt could be added inside any parts of the form as all parts are markup editable. For example it can be part of the (Current behavior). But I could not find the screenshot (attachment) button at first (Maybe it's a policy of git communities to get less files maybe). I think we would discuss about how to encourage or remind the reporter to put screenshots. Maybe inside comments. |
Thanks a lot for adding the templates to this and the other repos. I believe they are very good. So I will close this issue now. |
We still have no issue templating and contribution guidelines. It would be good to move forward here.
I would propose the following:
This list might not be complete and deserves discussion. In the next step I believe we can discuss the contribution guideline.
The text was updated successfully, but these errors were encountered: