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

Chronologue docs: Release Notes #19

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

Chronologue docs: Release Notes #19

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

Comments

@valeriahhdez
Copy link
Collaborator

valeriahhdez commented Jun 11, 2022 •
edited by kickoke
Loading

Summary

"Release Notes" is a changelog that provides developers with a description of the features that have been introduced and the features that have been deprecated as well as a description of why they were deprecated.

Research

  • Determine user goals.
  • 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: INSERT LINK IF SOURCE FILE ALREADY EXISTS
Template: INSERT LINK FOR THE TEMPLATE. All templates are located in: https://github.com/thegooddocsproject/templates/
@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

@fineon fineon

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

No branches or pull requests
3 participants
@kickoke @valeriahhdez @fineon