adam/engineering-handbook
1
0
Fork 0
mirror of https://github.com/Sea-Haven-Industries/engineering-handbook.git synced 2026-09-30 09:13:14 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
engineering-handbook/CONTRIBUTING.md
Adam Moussa 0333e7f8f5 Add engineering handbook 
Conventions covering naming, git workflow, commit messages, pull
requests, code review, GitHub standards, AWS infrastructure, SAM
project layout, and secrets management. Commit messages section
adapted from RomuloOliveira/commit-messages-guide (CC-BY-4.0).
2026-05-02 16:42:44 -04:00

715 B
Raw Blame History

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.