opendevstack / opendevstack/ods-documentation
add how to file an issue to documentation
Open
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 0
- Forks
- 6
- PR merge metrics
- No merged PRs in 30d
Description
As discussed at open office hours
- the documentation should explain, how a new issue can be added.
This is related to #4 , maybe those template links can be referenced in the documentation
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Start by reviewing the existing Antora documentation and related issue #4, including its template links. Document how a new issue can be filed and reference the relevant templates. Done means the generated documentation clearly explains the process and links to the templates.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100