mirror of
https://github.com/Sea-Haven-Industries/engineering-handbook.git
synced 2026-09-30 18:33:14 +00:00
Some checks are pending
ci / ci / ci (push) Waiting to run
docs: align engineering conventions for Cursor migration (PLAT-62)
727 B
727 B
Contributing
How to Suggest Changes
- Create a Jira ticket in
DEV,PLAT, orSEC, based on the change's scope - Or submit a PR with edits to the relevant markdown file
Style Guidelines
- Keep it concise and scannable
- Use headers, bullet points, and code blocks
- One topic per file
- Concrete examples are better than abstract rules
- No emoji
Adding a New Topic
If a convention doesn't fit into an existing file:
- Create a new kebab-case markdown file at the root (e.g.,
testing-standards.md) - Add a link to it in
README.mdunder the Contents section - Submit as a PR
License
Contributions to this repository are licensed under CC-BY-4.0.