Skip to content

Commit 8cf9b49

Browse files
mathemageCopilot
mathemage
and
Copilot
authored
feat(config): Add AI assistant instruction files (#2)
* feat(config): Add AI assistant instruction files #1 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix(config): Remove Kanban template from AGENTS.md, keep Strategy and Coding standards #1 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix(config): Replace web-app Strategy with repo-agnostic wording in AGENTS.md #1 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * feat(config): Copy Strategy and Coding standards sections to all AI assistant files #1 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix(config): Align commit message guidance wording #1 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix(config): Align coding standards with repo toolchains #1 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 7f6449b commit 8cf9b49

5 files changed

Lines changed: 105 additions & 0 deletions

File tree

‎.cursorrules‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Cursor Instructions
2+
3+
## Strategy
4+
5+
1. Write plan with success criteria for each phase to be checked off. Include project scaffolding, including .gitignore, and rigorous unit testing where applicable.
6+
2. Execute the plan ensuring all criteria are met
7+
3. Run thorough automated checks appropriate for this repository (for example, unit tests, problem-specific sample tests, and any available integration or end-to-end tests), fixing defects
8+
4. Only complete when the implementation meets the requirements and all relevant tests pass
9+
10+
## Coding standards
11+
12+
1. Use idiomatic approaches and library versions compatible with this repository's documented toolchains and constraints (for example, C++17 for C++ code)
13+
2. Keep it simple - NEVER over-engineer, ALWAYS simplify, NO unnecessary defensive programming. No extra features - focus on simplicity.
14+
3. Be concise. Keep README minimal. IMPORTANT: no emojis ever
15+
16+
## Git and GitHub
17+
18+
- For every task, first create a new Issue, then create the related branch, and finally open the related PR.
19+
- Use best practices for commit messages. Every commit message should follow this regex:
20+
`^(?:fix|chore|docs|feat|refactor|style|test)(?:\(.+\)): [A-Z].+(?:\s#\d+)?$`
21+
- Always use one of the commit type keywords (`fix`, `chore`, `docs`, `feat`, `refactor`, `style`, `test`) with an explicit scope in the `type(scope): Message` format (for example, `feat(api): Add new endpoint`).

‎.github/copilot-instructions.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# GitHub Copilot Instructions
2+
3+
## Strategy
4+
5+
1. Write plan with success criteria for each phase to be checked off. Include project scaffolding, including .gitignore, and rigorous unit testing where applicable.
6+
2. Execute the plan ensuring all criteria are met
7+
3. Run thorough automated checks appropriate for this repository (for example, unit tests, problem-specific sample tests, and any available integration or end-to-end tests), fixing defects
8+
4. Only complete when the implementation meets the requirements and all relevant tests pass
9+
10+
## Coding standards
11+
12+
1. Use idiomatic approaches and library versions compatible with this repository's documented toolchains and constraints (for example, C++17 for C++ code)
13+
2. Keep it simple - NEVER over-engineer, ALWAYS simplify, NO unnecessary defensive programming. No extra features - focus on simplicity.
14+
3. Be concise. Keep README minimal. IMPORTANT: no emojis ever
15+
16+
## Git and GitHub
17+
18+
- For every task, first create a new Issue, then create the related branch, and finally open the related PR.
19+
- Use best practices for commit messages. Every commit message should follow this regex:
20+
`^(?:fix|chore|docs|feat|refactor|style|test)(?:\(.+\)): [A-Z].+(?:\s#\d+)?$`
21+
- Always use one of the commit type keywords (`fix`, `chore`, `docs`, `feat`, `refactor`, `style`, `test`) with an explicit scope in the `type(scope): Message` format (for example, `feat(api): Add new endpoint`).

‎.windsurfrules‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Windsurf Instructions
2+
3+
## Strategy
4+
5+
1. Write plan with success criteria for each phase to be checked off. Include project scaffolding, including .gitignore, and rigorous unit testing where applicable.
6+
2. Execute the plan ensuring all criteria are met
7+
3. Run thorough automated checks appropriate for this repository (for example, unit tests, problem-specific sample tests, and any available integration or end-to-end tests), fixing defects
8+
4. Only complete when the implementation meets the requirements and all relevant tests pass
9+
10+
## Coding standards
11+
12+
1. Use idiomatic approaches and library versions compatible with this repository's documented toolchains and constraints (for example, C++17 for C++ code)
13+
2. Keep it simple - NEVER over-engineer, ALWAYS simplify, NO unnecessary defensive programming. No extra features - focus on simplicity.
14+
3. Be concise. Keep README minimal. IMPORTANT: no emojis ever
15+
16+
## Git and GitHub
17+
18+
- For every task, first create a new Issue, then create the related branch, and finally open the related PR.
19+
- Use best practices for commit messages. Every commit message should follow this regex:
20+
`^(?:fix|chore|docs|feat|refactor|style|test)(?:\(.+\)): [A-Z].+(?:\s#\d+)?$`
21+
- Always use one of the commit type keywords (`fix`, `chore`, `docs`, `feat`, `refactor`, `style`, `test`) with an explicit scope in the `type(scope): Message` format (for example, `feat(api): Add new endpoint`).

‎AGENTS.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# AI Coding Assistant Instructions
2+
3+
## Strategy
4+
5+
1. Write plan with success criteria for each phase to be checked off. Include project scaffolding, including .gitignore, and rigorous unit testing where applicable.
6+
2. Execute the plan ensuring all criteria are met
7+
3. Run thorough automated checks appropriate for this repository (for example, unit tests, problem-specific sample tests, and any available integration or end-to-end tests), fixing defects
8+
4. Only complete when the implementation meets the requirements and all relevant tests pass
9+
10+
## Coding standards
11+
12+
1. Use idiomatic approaches and library versions compatible with this repository's documented toolchains and constraints (for example, C++17 for C++ code)
13+
2. Keep it simple - NEVER over-engineer, ALWAYS simplify, NO unnecessary defensive programming. No extra features - focus on simplicity.
14+
3. Be concise. Keep README minimal. IMPORTANT: no emojis ever
15+
16+
## Git and GitHub
17+
18+
- For every task, first create a new Issue, then create the related branch, and finally open the related PR.
19+
- Use best practices for commit messages. Every commit message should follow this regex:
20+
`^(?:fix|chore|docs|feat|refactor|style|test)(?:\(.+\)): [A-Z].+(?:\s#\d+)?$`
21+
- Always use one of the commit type keywords (`fix`, `chore`, `docs`, `feat`, `refactor`, `style`, `test`) with an explicit scope in the `type(scope): Message` format (for example, `feat(api): Add new endpoint`).

‎CLAUDE.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Claude Code Instructions
2+
3+
## Strategy
4+
5+
1. Write plan with success criteria for each phase to be checked off. Include project scaffolding, including .gitignore, and rigorous unit testing where applicable.
6+
2. Execute the plan ensuring all criteria are met
7+
3. Run thorough automated checks appropriate for this repository (for example, unit tests, problem-specific sample tests, and any available integration or end-to-end tests), fixing defects
8+
4. Only complete when the implementation meets the requirements and all relevant tests pass
9+
10+
## Coding standards
11+
12+
1. Use idiomatic approaches and library versions compatible with this repository's documented toolchains and constraints (for example, C++17 for C++ code)
13+
2. Keep it simple - NEVER over-engineer, ALWAYS simplify, NO unnecessary defensive programming. No extra features - focus on simplicity.
14+
3. Be concise. Keep README minimal. IMPORTANT: no emojis ever
15+
16+
## Git and GitHub
17+
18+
- For every task, first create a new Issue, then create the related branch, and finally open the related PR.
19+
- Use best practices for commit messages. Every commit message should follow this regex:
20+
`^(?:fix|chore|docs|feat|refactor|style|test)(?:\(.+\)): [A-Z].+(?:\s#\d+)?$`
21+
- Always use one of the commit type keywords (`fix`, `chore`, `docs`, `feat`, `refactor`, `style`, `test`) with an explicit scope in the `type(scope): Message` format (for example, `feat(api): Add new endpoint`).

0 commit comments

Comments
 (0)