This repository was archived by the owner on Sep 24, 2022. It is now read-only.
This repository was archived by the owner on Sep 24, 2022. It is now read-only.
Chronologue docs: Bug reporting #15
Description
Summary
"Bug reporting" is a How-to guide that provides developers with an explanation of how to report API bugs and other issues with the Chronologue wenbsite.
Research
- Determine user goals.
- Determine prerequisites
- Determine what steps the user has to take.
Writing/Testing
- Create a new branch.
- Create a draft.
- Write a commentary in the document to highlight best practices.
- Take feedback notes for the template group.
- Create a PR.
Review
- Grammatical review.
- Technical review.
Publication
- Merge PR to
docs.
Resources
Source file: https://github.com/thegooddocsproject/templates/tree/dev/how-to
Template: https://github.com/thegooddocsproject/templates/tree/dev/how-to
Feedback form: INSERT LINK