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.

Sign up for GitHub

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

Jump to bottom

Enhancement: New default Deffcode project templates #2

Closed
4 tasks done
abhiTronix opened this issue Mar 10, 2022 · 0 comments · Fixed by #9
Closed
4 tasks done

Enhancement: New default Deffcode project templates #2

abhiTronix opened this issue Mar 10, 2022 · 0 comments · Fixed by #9
Assignees
@abhiTronix
Labels
Documentation 📑 Improvements or additions to DeFFcode documentation. Enhancement ⚡ New feature Issue/Request enhancing DeFFcode APIs. Solved 🥅 Final goal achieved.
Projects
Deffcode v0.2.0
Milestone
v0.2.0

Comments

@abhiTronix
Copy link
Owner

abhiTronix commented Mar 10, 2022 •
edited
Loading

Detailed Description

This issue will track creation of new default Issue and PR Templates for contributing to Deffcode with the latest format available.

Roadmap

  • Add new issue templates:
    • bug report
    • feature request
    • question
  • Add new PR Template
  • Add Deffcode Community Support
  • Follow latest GitHub formatting

Context

This issue will oversee implementation of new customized Issue and PR templates that are available for contributors to use when they open new issues in your repository.

Any Other Important Information

https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository
@abhiTronix abhiTronix self-assigned this Mar 10, 2022
@abhiTronix abhiTronix added Documentation 📑 Improvements or additions to DeFFcode documentation. Enhancement ⚡ New feature Issue/Request enhancing DeFFcode APIs. WIP 🏗️ Work in Progress labels Mar 10, 2022
@abhiTronix abhiTronix added this to To do in Deffcode v0.2.0 via automation Mar 10, 2022
@abhiTronix abhiTronix moved this from To do to In progress in Deffcode v0.2.0 Mar 10, 2022
@abhiTronix abhiTronix added this to the v0.2.0 milestone Mar 10, 2022
@abhiTronix abhiTronix moved this from In progress to To do in Deffcode v0.2.0 Mar 10, 2022
@abhiTronix abhiTronix mentioned this issue Mar 15, 2022
Merged
3 tasks
@abhiTronix abhiTronix linked a pull request Mar 15, 2022 that will close this issue
✨ Maintenance: New DeFFcode project issue and PR templates (Fixes #2) #9
Merged
3 tasks
Deffcode v0.2.0 automation moved this from To do to Done Mar 15, 2022
abhiTronix added a commit that referenced this issue Mar 15, 2022
@abhiTronix
✨ Maintenance: New DeFFcode project issue and PR templates (Fixes #2)…
d29cc1c 
… [PR #9]

- ✨ Added PR template:
  - 🚸 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.

- ✨ Added Proposal, Bug-Report and Question templates:
  - ✨ Created an `ISSUE_TEMPLATE` subdirectory to contain multiple issue templates.
  - 🚸 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.
    - 📝 Added Brief Description, Acknowledgment, Context, Current Environment, Any Other Information like blocks.
  - 🚸 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 Brief Description, Acknowledgment, Context, Current Environment, Expected Behavior, Actual Behavior, Possible Fix, Steps to reproduce, Miscellaneous like blocks.
  - ✨ 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 useful comments for convenience.
  - ✨ Added 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.

📝 Docs: 
- 📝 Updated Roadmap.
- 🐛 Fixed Gitter Community Link in Mkdocs.
@abhiTronix abhiTronix added Solved 🥅 Final goal achieved. and removed WIP 🏗️ Work in Progress labels Mar 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@abhiTronix abhiTronix

Labels
Documentation 📑 Improvements or additions to DeFFcode documentation. Enhancement ⚡ New feature Issue/Request enhancing DeFFcode APIs. Solved 🥅 Final goal achieved.
Projects
No open projects
Deffcode v0.2.0
Done
Milestone
v0.2.0
Development

Successfully merging a pull request may close this issue.

✨ Maintenance: New DeFFcode project issue and PR templates (Fixes #2) abhiTronix/deffcode
1 participant
@abhiTronix