chore: Update release docs and remove release script #175
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cjorge-graphops
requested changes
Nov 25, 2024
|
|
||
| Allegedly, clicking on the `Rebase and merge` button in the Github UI has | ||
| the same effect. | ||
| We try to keep the hostory of the `dev` branch linear, and avoid merge commits. Once your pull request is approved, merge using the `Rebase and merge` button in the Github UI. |
There was a problem hiding this comment.
Suggested change
| We try to keep the hostory of the `dev` branch linear, and avoid merge commits. Once your pull request is approved, merge using the `Rebase and merge` button in the Github UI. | |
| We try to keep the history of the `dev` branch linear, and avoid merge commits. Once your pull request is approved, merge using the `Rebase and merge` button in the Github UI. |
Comment on lines
+61
to
-87
| git tag <X.X.X> | ||
| git push --tags | ||
| ``` | ||
| git tag -a vX.X.X -m "vX.X.X" |
There was a problem hiding this comment.
Are we intentionally changing doc to go from annotated tags to "regular"? (dropping the -a). I'd also suggest to start campaigning for signing tags along with commits
| ``` | ||
|
|
||
| It's important to note that all changes to the `main` branch should go through pull requests and be reviewed by at least one project admin. This helps ensure that the `main` branch only contains clean releases and that any issues or bugs are caught before they are released to our users. | ||
| To start working on a new feature or bug fix, contributors should create a new branch off of the dev branch. Once the feature or bug fix is complete, a pull request should be created to merge the changes into the dev branch. All changes to the dev branch should be reviewed by at least one other person before merging. |
There was a problem hiding this comment.
Think in some places here "should" really is a "need", and the original wording of project admin should be kept. One of the reasons for that is this is a public repo and this doc is meant to also serve external contributors: they can't merge on their own (or with only other external reviewers)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Update release docs and remove release script