docs: add project conventions and constraints documentation

[mrrajan]

Summary

• Add CONVENTIONS.md documenting coding conventions for the Trustify Helm charts:
  • Language/framework standards (Helm 3, Go templates)
  • Code style (2-space YAML indentation, nindent usage)
  • Naming conventions (template helpers, helper files, Kubernetes resources, module variables, values keys)
  • File organization for both charts
  • Error handling patterns (required, default, with, if)
  • Testing conventions
  • Commit message format (Conventional Commits)
  • Shared modules and reuse patterns
• Add docs/constraints.md documenting deployment constraints

Test plan

• Verify CONVENTIONS.md is accurate against the current codebase patterns
• Verify docs/constraints.md reflects current deployment constraints

Implements TC-5194

[sourcery-ai]

Reviewer's Guide

Adds project-wide coding conventions for Helm-based charts and documents deterministic architectural constraints for SDLC workflow skills, commits, PRs, and task templates.

Flow diagram for SDLC workflow steps and documented constraints

flowchart LR
  plan_feature[plan-feature skill]
  define_feature[define-feature skill]
  implement_task[implement-task skill]
  jira_task[Jira task]
  git_commit[Git commit]
  pull_request[Pull request]
  constraints_docs[docs/constraints.md]

  plan_feature --> jira_task
  define_feature --> jira_task
  jira_task --> implement_task
  implement_task --> git_commit
  git_commit --> pull_request

  constraints_docs --- plan_feature
  constraints_docs --- define_feature
  constraints_docs --- implement_task
  constraints_docs --- git_commit
  constraints_docs --- pull_request

Loading

File-Level Changes

Change	Details	Files
Introduce a coding conventions document for Helm charts and project structure.	Create a CONVENTIONS.md file outlining language/framework expectations and chart layout. Define naming conventions for helpers, Kubernetes resources, values keys, and module variables. Document error-handling, testing, commit message, shared module, documentation, dependency, and performance-related practices for the charts.	CONVENTIONS.md
Define architectural constraints and traceability for SDLC workflow skills, commits, PRs, tasks, and code changes.	Create a docs/constraints.md file listing deterministic rules for skill scopes, commits, PR workflow, task templates, and code changes. Link each constraint to its originating SKILL or methodology documentation to enable traceability. Summarize the source documents that define these constraints in a traceability index section.	docs/constraints.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey - I've left some high level feedback:

• The hard-coded Helm version and schema generation command in CONVENTIONS.md may become outdated over time; consider referencing a single canonical script or makefile target instead of embedding the full command and version here.
• Several rules in docs/constraints.md duplicate information from the referenced SKILL/methodology files; you might want to note how this document will be kept in sync (or partially generated) to avoid drift between sources.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- The hard-coded Helm version and schema generation command in `CONVENTIONS.md` may become outdated over time; consider referencing a single canonical script or makefile target instead of embedding the full command and version here.
- Several rules in `docs/constraints.md` duplicate information from the referenced SKILL/methodology files; you might want to note how this document will be kept in sync (or partially generated) to avoid drift between sources.

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}