34 lines
940 B
Markdown
34 lines
940 B
Markdown
# Contributing
|
|
|
|
Thanks for improving the Playbook templates and tooling. This repo is a template
|
|
source for downstream projects, so changes should stay small, predictable, and
|
|
backwards compatible when possible.
|
|
|
|
## What to change
|
|
|
|
- Templates: `templates/`, `rulesets/`, `docs/`
|
|
- Tooling: `scripts/`, `tools/tsl-codegen/`
|
|
- Tests: `test/`
|
|
|
|
## Commit messages
|
|
|
|
Follow `docs/common/commit_message.md` and use the required emoji/type mapping.
|
|
|
|
## Tests
|
|
|
|
Run the relevant checks before pushing:
|
|
|
|
```bash
|
|
npm run lint:md
|
|
python -m unittest discover -s test -p "test_*.py" -v
|
|
python test/integration/check_doc_links.py
|
|
```
|
|
|
|
## Templates and docs
|
|
|
|
- Keep placeholder definitions documented in `templates/README.md`.
|
|
- Update template last-updated dates when changing template content.
|
|
|
|
TSL API 页面、索引、数据字典和 Framework Profile 的仓库维护流程见
|
|
[`tools/tsl-codegen/MAINTENANCE.md`](tools/tsl-codegen/MAINTENANCE.md)。
|