search

aws / graph-explorer

React-based web application that enables users to visualize both property graph and RDF data and explore connections between data without having to write graph queries.
https://github.com/aws/graph-explorer
Apache License 2.0
314 stars 46 forks source link

Update GitHub issue templates #323

Closed kmcginnes closed 4 months ago

kmcginnes commented 4 months ago

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

Related Issues

kmcginnes commented 4 months ago

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.