Expand issue template to encourage people to look at other resources first
Open
@joshua-white is already working on this.
Since Jul 29, 2021.
type: documentation
- Dominant language
- C++
- Stars
- 287
- Forks
- 109
- Avg merge
- 4d 41m
- Merged PRs (30d)
- 5
Description
While it is good for users to post issues, there are certain cases where we want to direct them to the discussions first, etc. We can expand the issue template to provide some extra guidance.
As an extreme example, here is spack's issue template:
Steps to reproduce the issue
$ spack install <spec>
...
Information on your system
Additional information
- spack-build-out.txt
- spack-build-env.txt
General information
- I have run
spack debug reportand reported the version of Spack/Python/Platform - I have run
spack maintainers <name-of-the-package>and @mentioned any maintainers - I have uploaded the build log and environment files
- I have searched the issues of this repo and believe this is not a duplicate
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.