Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a CHANGELOG #116

Open
umoqnier opened this issue Sep 3, 2021 · 0 comments
Open

Add a CHANGELOG #116

umoqnier opened this issue Sep 3, 2021 · 0 comments
Assignees
Labels
docs Improvements or additions to documentation enhancement New feature or request

Comments

@umoqnier
Copy link
Member

umoqnier commented Sep 3, 2021

Is your feature request related to a problem? Please describe.
A changelog can be useful for historic proposes because logs notable changes in the code in a human readable format

Describe the solution you'd like
Create a CHANGELOG.md file in the root of the repo and log notable changes

Additional context
To get a consisten changelog file is necesary to get a tags version system. I recommend the next schema: MAYOR.MINIOR.HOTFIX

Example:

  • 0.0.1: First commit
  • 0.0.2: Fixing a bug: Broke the admin UI when upload incorrect format texts
  • 0.1.0: Change some code: A better way to get texts, changing colors and styles, deleting innecesary code
  • 1.0.0: Adding a new feature: Delete rows in a document

A complete style guide for the changelog can be found here: https://keepachangelog.com/en/1.0.0/

@umoqnier umoqnier added docs Improvements or additions to documentation enhancement New feature or request labels Sep 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants