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 Release Guidelines to document release process #838

Closed
1 task
Tracked by #651
frtibble opened this issue May 8, 2024 · 0 comments · Fixed by #865
Closed
1 task
Tracked by #651

Add Release Guidelines to document release process #838

frtibble opened this issue May 8, 2024 · 0 comments · Fixed by #865
Assignees
Labels
subtask A subtask

Comments

@frtibble
Copy link
Contributor

frtibble commented May 8, 2024

Part of #651

Description

Introducing versioning means the addition of several new (to the repo) concepts such as conventional commit messages and semantic versioning. Documentation needs to be included which explains what these are and how they are used, e.g. what is considered a breaking change.

Additionally, the changes which introduce versioning need to be explained so that anyone coming to the repo could understand how it works, e.g. how GitHub actions creates a release PR, how to do a manual release, etc.

Tasks

  • Add docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
subtask A subtask
Projects
None yet
1 participant