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 documentation for version numbering and releases #809

Merged
merged 3 commits into from
Oct 31, 2024

Conversation

Niederb
Copy link
Contributor

@Niederb Niederb commented Oct 29, 2024

I tried to come up with some documentation regarding the new versioning strategy and to make our release approach more explicit.

@Niederb Niederb self-assigned this Oct 29, 2024
@Niederb Niederb added E1-breaksnothing F4-documentation Updates the documentation labels Oct 29, 2024
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@haerdib haerdib left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you also update the developer doc section?

Epsecially the https://github.com/scs/substrate-api-client/tree/master/docs#todo-list-for-a-new-release
and https://github.com/scs/substrate-api-client/tree/master/docs#semantic-versioning

or we can create an issue and do this in a separate PR

@Niederb
Copy link
Contributor Author

Niederb commented Oct 31, 2024

@haerdib I updated the developer docs

@Niederb Niederb requested a review from haerdib October 31, 2024 09:01
Copy link
Contributor

@haerdib haerdib left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool, thanks a lot!

@Niederb Niederb marked this pull request as ready for review October 31, 2024 09:46
@Niederb Niederb merged commit b33a676 into master Oct 31, 2024
60 checks passed
@Niederb Niederb deleted the tn/version-and-release-documentation branch October 31, 2024 09:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
E1-breaksnothing F4-documentation Updates the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants