engineering-handbook/CONTRIBUTING.md

727 B

Contributing

How to Suggest Changes

  • Create a Jira ticket in DEV, PLAT, or SEC, 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:

  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.