-
Notifications
You must be signed in to change notification settings - Fork 85
Add git workflow cursor rule #1544
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
Open
mirooon
wants to merge
2
commits into
main
Choose a base branch
from
add-git-workflow-cursor-rule
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| --- | ||
| name: Git workflow and pull request conventions | ||
| description: Branching strategy, PR targeting, and git command guidance | ||
| globs: | ||
| - '.git/**' | ||
| - '.github/pull_request_template.md' | ||
| - '.github/**/*.md' | ||
| - '**/*.md' | ||
| alwaysApply: false | ||
| --- | ||
|
|
||
| ## Git Workflow and Branching Strategy | ||
|
|
||
| ### Branching Model | ||
|
|
||
| - **Base branch**: All feature branches must be created directly from `main` | ||
| - **Branch naming**: Use descriptive names with Jira ticket numbers (e.g., `feature/smar-123-add-new-bridge`, `fix/smar-456-hop-integration`, `chore/smar-789-update-deps`) | ||
| - Format: `{type}/{JIRA-TICKET}-{description}` | ||
| - Include Jira ticket number (e.g., `smar-123`) in branch name | ||
| - Use kebab-case for description | ||
|
|
||
| ### Pull Request Targeting | ||
|
|
||
| - **Default target**: Pull Requests should target `main` directly | ||
| - **Splitting large topics**: For large topics, it is acceptable to split into multiple smaller, focused PRs. In such cases: | ||
| - Create a feature branch from `main` (e.g., `feature/smar-123-large-topic`) | ||
| - Create multiple PRs targeting this feature branch (not `main`) | ||
| - This allows reviewing cumulative changes together in the GitHub changes tab | ||
| - Once all component PRs are merged into the feature branch, create a final PR from the feature branch to `main` | ||
| - **Rationale**: Default to `main` simplifies review and reduces merge conflicts. Feature branch targeting for large topics enables better cumulative change review | ||
|
|
||
| ### Special Cases: Always Target Main | ||
|
|
||
| Certain file types **must always** target `main`, regardless of whether related work is fully merged: | ||
|
|
||
| - **`config/whitelist.json`**: Any PR that updates `whitelist.json` must target `main`, even if: | ||
| - The new network isn't fully merged yet with `main` | ||
| - The network is still not in `networks.json` | ||
| - This is totally fine and expected | ||
|
|
||
| - **`config/composerWhitelist.json`**: Any PR that updates `composerWhitelist.json` must target `main`, following the same guidelines as `whitelist.json` (even if related network work isn't fully merged) |
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.