mirror of
https://github.com/Sea-Haven-Industries/engineering-handbook.git
synced 2026-09-30 17:23:14 +00:00
27 lines
715 B
Markdown
27 lines
715 B
Markdown
|
# Contributing
|
||
|
|
|
||
|
|
## How to Suggest Changes
|
||
|
|
|
||
|
|
- Open an issue describing the proposed change and why it's needed
|
||
|
|
- 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:
|
||
|
|
|
||
|
|
1. Create a new kebab-case markdown file at the root (e.g., `testing-standards.md`)
|
||
|
|
2. Add a link to it in `README.md` under the Contents section
|
||
|
|
3. Submit as a PR
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
Contributions to this repository are licensed under [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/).
|