✨ Maintenance: New DeFFcode project issue and PR templates (Fixes #2) #9
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
- 🚸 Added a pull request template(`PULL_REQUEST_TEMPLATE.md`) for project contributors to automatically see the template's contents in the pull request body. - 📝 Added Brief Description, Requirements / Checklist, Related Issue, Context, Types of changes blocks. - 💡 Added useful comments for convenience. (Note: Most of this code is borrowed from https://github.com/abhiTronix/vidgear)
- 🚸 Add manually-created Proposal(`proposal.md`) and Question(`question.md`) issue template for project contributors to automatically see the template's contents in the issue body. - ✨ Created an `ISSUE_TEMPLATE` subdirectory to contain multiple issue templates. - ✨ Added YAML frontmatter to each issue template to pre-fill the issue title, automatically add labels and assignees, and give the template a name and description. - 📝 Added Brief Description, Acknowledgment, Context, Current Environment, Any Other Information like blocks. - 💡 Added useful comments for convenience.
- 🚸 Add an manually-created Bug Report(`bug_report.md`) issue template to `ISSUE_TEMPLATE` subdirectory for project contributors to automatically see the template's contents in the issue body. - ✨ Added YAML frontmatter to each issue template to pre-fill the issue title, automatically add labels and assignees, and give the template a name and description. - 📝 Added Brief Description, Acknowledgment, Context, Current Environment, Expected Behavior, Actual Behavior, Possible Fix, Steps to reproduce, Miscellaneous like blocks. - 💡 Added useful comments for convenience. (Note: Most of this code is borrowed from https://github.com/abhiTronix/vidgear)
- ✨ Add a `config.yml` file to the `.github/ISSUE_TEMPLATE` folder to customize the issue template chooser that people see when creating a new issue. - ♿️ Set `blank_issues_enabled` parameter to `false` to encourage contributors to use issue templates. - 🚸 Added `contact_links` parameter with gitter community link to receive regular issues outside of GitHub. (Note: Most of this code is borrowed from https://github.com/abhiTronix/vidgear)
abhiTronix
added
Enhancement ⚡
4 tasks
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.
Brief Description
This PR will implement of new Issue and PR Templates for contributing to DeFFcode with the latest format available.
Changes
PULL_REQUEST_TEMPLATE.md) for project contributors to automatically see the template's contents in the pull request body.ISSUE_TEMPLATEsubdirectory to contain multiple issue templates.proposal.md) and Question(question.md) issue template for project contributors to automatically see the template's contents in the issue body.bug_report.md) issue template toISSUE_TEMPLATEsubdirectory for project contributors to automatically see the template's contents in the issue body.config.ymlfile to the.github/ISSUE_TEMPLATEfolder to customize the issue template chooser that people see when creating a new issue.blank_issues_enabledparameter tofalseto encourage contributors to use issue templates.contact_linksparameter with gitter community link to receive regular issues outside of GitHub.📝 Docs:
Related Issue
#2
Context
This PR will implement new customized Issue and PR templates that are available for contributors to use when they open new issues in your repository.
Types of changes