Skip to content
This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

Chronologue docs: Bug reporting #15

Open
11 tasks
valeriahhdez opened this issue Jun 11, 2022 · 0 comments
Open
11 tasks

Chronologue docs: Bug reporting #15

valeriahhdez opened this issue Jun 11, 2022 · 0 comments
Assignees
@kickoke
Labels
documentation Improvements or additions to documentation

Comments

@valeriahhdez
Copy link
Collaborator

valeriahhdez commented Jun 11, 2022 •
edited
Loading

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
@valeriahhdez valeriahhdez added the documentation Improvements or additions to documentation label Jun 11, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@kickoke kickoke

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@kickoke @valeriahhdez