Skip to content

Commit 9fa27eb

Browse files
Copilotrjaegers
andcommitted
docs: add conventional commit guidelines to copilot instructions
Co-authored-by: rjaegers <[email protected]>
1 parent 472f76b commit 9fa27eb

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

.github/copilot-instructions.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,30 @@ The folder structure of amp-devcontainer is described below, adhere to the exist
2424
- `/.devcontainer/[flavor]-test`: Contains a devcontainer.json file for testing the container flavor.
2525
- `/.github`: Contains the GitHub workflows for CI/CD, linter configuration, issue templates and re-usable actions.
2626
- `/test/[flavor]`: Contains [Bats](https://bats-core.readthedocs.io/en/stable/) integration- and Playwright verification tests for the containers.
27+
28+
## Conventional Commits
29+
30+
This repository uses [conventional commit](https://www.conventionalcommits.org/) style for pull request titles and commit messages. Always follow this format:
31+
32+
```
33+
<type>[optional scope]: <description>
34+
35+
[optional body]
36+
37+
[optional footer(s)]
38+
```
39+
40+
Common types used in this repository:
41+
- `feat:` for new features
42+
- `fix:` for bug fixes
43+
- `chore:` for maintenance tasks, dependency updates, etc.
44+
- `docs:` for documentation changes
45+
- `ci:` for CI/CD related changes
46+
47+
Examples:
48+
- `feat: add non-root user support to devcontainers`
49+
- `fix: resolve permission issues in rust container`
50+
- `chore(deps): update ubuntu base image to latest`
51+
- `docs: update README with security best practices`
52+
53+
Always use conventional commit style for pull request titles.

0 commit comments

Comments
 (0)