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

Update GitHub issue templates #323

Closed
3 tasks done
kmcginnes opened this issue Apr 25, 2024 · 1 comment · Fixed by #332
Closed
3 tasks done

Update GitHub issue templates #323

kmcginnes opened this issue Apr 25, 2024 · 1 comment · Fixed by #332
Assignees
Labels
enhancement New feature or request infrastructure
Milestone

Comments

@kmcginnes
Copy link
Collaborator

kmcginnes commented Apr 25, 2024

The current issue structure can be vastly improved with some simple enhancements to the formatting and wording.

Today, issue submitters are leaving what were designed to be comments to the author in the description of the issue.

We should instead provide those notes to the author in HTML comments within the Markdown so that they won't be rendered.

Tasks

  • Issues -- bug template
  • Issues -- feature request template
  • Issues -- security vulnerability template

Related Issues

@kmcginnes kmcginnes converted this from a draft issue Apr 25, 2024
@kmcginnes kmcginnes added enhancement New feature or request infrastructure labels Apr 25, 2024
@kmcginnes
Copy link
Collaborator Author

kmcginnes commented Apr 29, 2024

I've been using this recently for my feature requests, and I like the way it reads:

## Description
Provide a description of the enhancement you would like to see included in Graph Explorer

## Additional Context
Provide any inciting incidents or features, any dependencies, any potential research that must be done, etc.

## Related Issues
Relates to issue #xxx.

## Tasks
- [ ] Add any known subtasks

---

> [!IMPORTANT]
> If you are interested in working on this issue or have submitted a pull request, please leave a comment.

> [!TIP]
> Please use a 👍 reaction to provide a +1/vote. 
> 
> This helps the community and maintainers prioritize this request.

@kmcginnes kmcginnes linked a pull request Apr 29, 2024 that will close this issue
6 tasks
@kmcginnes kmcginnes moved this from 🔖 Ready to 🏗 In progress in Graph Explorer Planning May 1, 2024
@kmcginnes kmcginnes moved this from 🏗 In progress to 👍 Approved in Graph Explorer Planning May 1, 2024
@kmcginnes kmcginnes added this to the Release 1.6.1 milestone May 1, 2024
@kmcginnes kmcginnes self-assigned this May 2, 2024
@github-project-automation github-project-automation bot moved this from 👍 Approved to ✅ Done in Graph Explorer Planning May 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request infrastructure
Projects
No open projects
Status: ✅ Done
Development

Successfully merging a pull request may close this issue.

1 participant