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 an issue template #5

Closed
github-learning-lab bot opened this issue Jan 14, 2021 · 0 comments
Closed

Add an issue template #5

github-learning-lab bot opened this issue Jan 14, 2021 · 0 comments

Comments

@github-learning-lab
Copy link
Contributor

Understanding contributors

Most contributors take a gradual path to getting involved in an open source community. It usually looks something like this:

  1. Reporting a bug
  2. Suggesting a new feature
  3. Creating a pull request

More seasoned open source contributors might go straight to creating their first pull request, so adding helpful templates to a repository that makes it easier for everyone to get involved, regardless of their previous experience.

Step 6: Adding an issue template

When you add an issue template and pull request template to your repository, project contributors will automatically see the template's contents when they open a new issue or pull request. Templates help you standardize the information you'd like included when contributors open issues.

GitHub offers standard templates for bug reports and for feature requests. We'll utilize those here.

📖 GitHub help docs: Configuring issue templates for your repository

Creating multiple templates

In open source projects, templates make it easy for new contributors to create bug reports, suggest new features, or contribute changes. Can you put one together for bugs?

⌨️ Activity: Adding an issue template

GIF showing a click on the repository's settings tab, scrolling down, clicking on set up templates, selecting a bug report template, a feature request template, and a custom template. Then, clicking on propose changes, changing the branch name to templates, and then committing. Finally, a new PR shows up.

  1. Access this quicklink for templates or manually navigate to it as follows:
    • Click on your repository's Settings tab.
    • Scroll down to the Features section
    • Click on Set up templates
  2. Click on Add a template: select
  3. Select the bug report template.
    • Feel free to add more than one template, or create custom templates.
  4. Click Propose changes
  5. Enter a commit message, choose a name for your branch, and click Commit changes. GitHub will create a new pull request titled Update issue templates for you.

I'll respond when I detect a new pull request titled Update issue templates.

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

0 participants