Repository navigation
docs(contributors): update default branch info - #21
Merged
Merged
Conversation
Contributor
Reviewer's Guide by SourceryThis pull request updates the documentation to reflect changes in the default branch naming conventions. Specifically, it replaces references to the 'dev' branch with 'default branch' to accommodate different project setups where 'main' might be used directly as the default branch. File-Level Changes
Tips
|
Contributor
There was a problem hiding this comment.
Hey @uniqueg - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟡 Documentation: 1 issue found
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.
| state, i.e., those with version numbers below `v1.0.0`. Upon release, | ||
| `main` becomes the default branch, and [semantic versioning][sem-ver] is | ||
| strictly adhered by. In some cases, there may not be a `dev` branch and | ||
| `main` is used as the default branch straight away. |
Contributor
There was a problem hiding this comment.
suggestion (documentation): Consider adding a comma for clarity.
Consider adding a comma after 'branch' for better readability: 'In some cases, there may not be a dev branch, and main is used as the default branch straight away.'
This file contains hidden or 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
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.
Summary by Sourcery
This pull request updates the contributor guidelines to use the term 'default branch' instead of 'dev' branch, providing clarity on branch usage based on the project's release state.