Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .clinerules/02-github-workflow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# GitHub Workflow

When solving an issue that requires code changes, follow this workflow:

1. **Create a branch:** Use the `create_branch` tool from the `github.com/github/github-mcp-server` to create a new branch for the issue. The branch name should be descriptive, like `fix/1234-description` or `feat/1234-description`.
2. **Commit changes:** After making the necessary code changes, use the `create_or_update_file` or `push_files` tool to commit the changes to the new branch. The commit message should be descriptive and reference the issue number.
3. **Create a pull request:** Use the `create_pull_request` tool to open a new pull request from the branch to the main branch of the repository. The pull request title and body should be descriptive and reference the issue number.

Do not fork the repository unless absolutely necessary. Use the provided GitHub MCP server tools to work directly with the repository.
1 change: 1 addition & 0 deletions .clinerules/03-dev-workflow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
When running checkov and adding code to this code base, don't run tests or try to install dependencies using pip, pipenv, or any other package manager.
7 changes: 7 additions & 0 deletions .clinerules/04-testing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Testing Guidelines

When adding new features or fixing bugs, it is important to add or update tests to ensure the code is working as expected and to prevent future regressions.

- **Unit Tests:** For isolated components, add unit tests to verify their functionality.
- **Integration Tests:** For features that involve multiple components, add integration tests to ensure they work together correctly.
- **Test Coverage:** Aim for high test coverage to ensure all parts of the code are tested.
18 changes: 18 additions & 0 deletions .clinerules/05-commit-messages.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Commit Message Guidelines

Follow these guidelines when writing commit messages to maintain a clear and organized project history.

- **Subject Line:**
- Keep it short and descriptive (under 50 characters).
- Use the imperative mood (e.g., "Add feature" not "Added feature").
- Capitalize the first letter.
- Do not end with a period.

- **Body (Optional):**
- Provide more context for the changes.
- Explain the "what" and "why" of the changes, not the "how".
- Separate the subject from the body with a blank line.
- Wrap the body at 72 characters.

- **Footer (Optional):**
- Reference any relevant issue or pull request numbers (e.g., "Closes #123").
3 changes: 3 additions & 0 deletions .clinerules/06-pr-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Pull Request Body Template

When creating a pull request, the body of the pull request must be populated with the content from the `.github/PULL_REQUEST_TEMPLATE.md` file.
40 changes: 40 additions & 0 deletions .clinerules/workflows/solve‑issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# solve-issue.md
<parameters>
issue: "GitHub issue number (e.g. 7239)"
</parameters>

# 0. Setup (always)
- Create/overwrite a dedicated branch
<github.create_branch>
branch: "fix/issue-{{issue}}"
from_branch: "main"
</github.create_branch>

# 1. Load the GitHub issue for context (always)
<terminal>gh issue view {{issue}} --json title,body,labels,url</terminal>

# 2. Research & implement fix (always)
- Detect tech stack from labels/body.
- <browser.search> "{{tech}} {{relevant keyword}}" for docs/examples.
- Edit or add code to address the issue.
- Stage all changes.

# 3. Run tests (don't run)
# <terminal>npm test</terminal>
# <terminal>pytest</terminal>

# 4. Commit & push (always)
<github.push_files>
branch: "fix/issue-{{issue}}"
message: "Fix(#{{issue}}): A brief description of the fix"
files: "{{list of modified files}}"
</github.push_files>

# 5. Open a pull request (always)
<github.create_pull_request>
title: "Fix(#{{issue}}): A brief description of the fix"
body: "Closes #{{issue}}. A more detailed description of the changes."
</github.create_pull_request>

# 6. Finish (always)
<exit>Done – PR is open and ready for review. 🎉</exit>
Loading