Added issue templates tool #86
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
InessaPawson
requested changes
Jun 16, 2024
There was a problem hiding this comment.
@DeaMariaLeon Thank you so much for working on this article! We could use 2-3 more good examples for GH issue templates, maybe outside of the Python community. But this is not a blocker.
| ## GitHub Issue templates | ||
|
|
||
| If you have your project in GitHub, you can create issue templates or forms. | ||
| These allow you ask relevant information to contributors wanting to open a new issue to your repository. |
There was a problem hiding this comment.
Suggested change
| These allow you ask relevant information to contributors wanting to open a new issue to your repository. | |
| These allow you to ask for relevant information from contributors wanting to open a new issue to your repository. |
Minor grammar edits.
| These allow you ask relevant information to contributors wanting to open a new issue to your repository. | ||
|
|
||
| You can have a template for each type of issue. For example, it can be a bug report, | ||
| a request for a new feature, or a problem in the documentation. You could also ask for more |
There was a problem hiding this comment.
Suggested change
| a request for a new feature, or a problem in the documentation. You could also ask for more | |
| a request for a new feature, or a suggestion to improve project's documentation. You could also ask for more |
Let's make it more general as it could also be adding more content to the existing project documentation.
There was a problem hiding this comment.
Done, thanks.
| settings of your repository, or you can create them with `YAML` format files. | ||
|
|
||
| If you create the templates writing yourself the `YAML` format files, you can create them | ||
| locally (in your machine) and push them to your repository when ready. |
There was a problem hiding this comment.
Suggested change
| locally (in your machine) and push them to your repository when ready. | |
| locally (on your machine) and push them to your repository when ready. |
| For a step by step guide, please visit the | ||
| [GitHub documentation](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository). | ||
|
|
||
| ## Examples of how templates are done |
There was a problem hiding this comment.
Suggested change
| ## Examples of how templates are done | |
| ## Examples of GitHub issue templates |
InessaPawson
approved these changes
Jun 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I hope this is close to what we discussed @InessaPawson
Feedback welcome.