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

improve onboarding for newcomers: issue template, PR template, template chooser #396

Closed
HonkingGoose opened this issue Mar 18, 2021 · 3 comments · Fixed by #397
Closed

Comments

@HonkingGoose
Copy link
Contributor

Problems

Current issue template has a wall of text that a contributor needs to remove each time, it also does not contain a logical structure of the things the contributor needs to provide to be a good issue.
The wall of text tries to redirect unwanted stuff, but it's not very convenient, as you cannot click on the provide links and go to the proper place.

There are also no pull request template to guide new contributors.

Solution:

  1. Create proper issue template.
  2. Redirect unwanted stuff via the new "issue template" screen that GitHub now offers.
  3. Trim down wall of text in issue template as we can use the template chooser screen to redirect unwanted stuff.
  4. Create pull request template.
  5. Create config.yml file (https://docs.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser)

Do you want a PR from me to fix these items?

If you want, I can make a PR for all the stuff above so you don't have to.
We can then fine-tune the text in those items together.

@HonkingGoose
Copy link
Contributor Author

I'll go make a PR then. 😉

@github-actions
Copy link
Contributor

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days

@github-actions github-actions bot added the Stale label Apr 19, 2021
@C0ZEN
Copy link
Contributor

C0ZEN commented Apr 19, 2021

up

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

Successfully merging a pull request may close this issue.

2 participants