Skip to content
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

Closed
EPajares opened this issue May 29, 2021 · 5 comments
Closed

Add contribution guideline and issue templating to the repository #1107

EPajares opened this issue May 29, 2021 · 5 comments
Assignees

Comments

@EPajares
Copy link
Collaborator

EPajares commented May 29, 2021

We still have no issue templating and contribution guidelines. It would be good to move forward here.
I would propose the following:

  • Issue template bug
  • Issue template new feature idea
  • Issue template concrete task
  • Blank or generic template for other issues.

This list might not be complete and deserves discussion. In the next step I believe we can discuss the contribution guideline.

@EPajares EPajares changed the title Add contribution guidleline and issue templating to the repository Add contribution guideline and issue templating to the repository May 29, 2021
@EPajares
Copy link
Collaborator Author

@metemaddar: maybe you can take the lead on this one. And we can support here :)

metemaddar added a commit that referenced this issue Jun 30, 2022
related issue: #1107
@metemaddar
Copy link
Contributor

metemaddar commented Jun 30, 2022

Thanks for assign this valuable and attractive task also to me while it gives me great sight over the issues/PR process.
I've created a PR to add issue templates. So we can check it and also edit the templates there. The templates are created from the default examples and the following references.

Add templates for PRs also

We can also have issue templates for PRs which also have guidelines to auto-close related issues, summaries, and more. (Using this guideline)

For blank template

As 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 repository

Found this great repository which has examples for technical aspects to create issue/PR templates: https://github.com/stevemao/github-issue-templates
Used for Bug report template

More links

I found some great videos about issue templates:

  1. GitHub Issue Templates - GitHub Project Management Tutorial
  2. Get started with GitHub issue forms - GitHub Checkout

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.
A very simple yet useful template from the above link is used to create new tasks.

@EPajares
Copy link
Collaborator Author

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.

@metemaddar
Copy link
Contributor

I'm very agree about starting with simple templates as they can better fit to our needs in the future.
Now we have:

  • Pull Request template
    • It works also on a forked repository PR to GOAT.
  • Concrete task template
  • Feature request template
  • Bug report template
  • Bug report form

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 screenshots

It 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.

@EPajares
Copy link
Collaborator Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants