-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathCONTRIBUTING.md.j2
More file actions
60 lines (38 loc) · 2.44 KB
/
CONTRIBUTING.md.j2
File metadata and controls
60 lines (38 loc) · 2.44 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# Contributing to {{ name }}
Thank you for your interest in contributing.
## Getting Started
1. Fork the repository
2. Create a feature branch from `main`
3. Make your changes following the conventions below
4. Submit a pull request
## Conventions
### Commits
Use [Conventional Commits](https://www.conventionalcommits.org/):
- `feat:` -- new feature, skill, rule, or MCP tool
- `fix:` -- bug fix
- `docs:` -- documentation changes
- `chore:` -- maintenance, dependency updates
- `refactor:` -- code restructuring
### Skills
- Create a directory under `skills/` with a descriptive kebab-case name
- Include a `SKILL.md` with YAML frontmatter (`title`, `description`, `globs`)
- Add the path to `.cursor-plugin/plugin.json`
### Rules
- Create a `.mdc` file under `rules/`
- Include frontmatter with `description`, `globs`, and `alwaysApply`
- Add the path to `.cursor-plugin/plugin.json`
## Pull Request Process
1. Ensure CI passes (the `validate.yml` workflow checks structure and quality)
2. Update `CHANGELOG.md` if the change is user-facing
3. Use a descriptive PR title following conventional commit format
## Inbound license grant and DCO
This project's outbound license is {{ license_spdx }}. Contributions are accepted inbound under a broader grant via the Developer Certificate of Origin (DCO). Both pieces are required because {{ license_spdx }} alone cannot cleanly accept third-party derivatives.
### Required grant
By submitting a contribution to this repository, you certify that you have the right to do so under the Developer Certificate of Origin (DCO) 1.1, and you grant TMHSDigital a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license to use, reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute your contribution under the project's current license ({{ license_spdx }}) or any successor license chosen by the project.
### DCO sign-off
Every commit in a pull request must carry a `Signed-off-by:` trailer matching the commit author. Sign at commit time with the `-s` flag:
```bash
git commit -s -m "feat: add new skill"
```
This appends a line like `Signed-off-by: Jane Developer <jane@example.com>` to the commit message. The GitHub DCO App enforces this on every PR.
For the full inbound/outbound model and rationale, see [`standards/licensing.md`](https://github.com/TMHSDigital/Developer-Tools-Directory/blob/main/standards/licensing.md) in the Developer-Tools-Directory meta-repo.