NOERITH Repository Starter

Secure, reusable project foundation for NOERITH repositories.

{{PROJECT_STATUS}}

{{PROJECT_PROBLEM}}

This repository was created from the NOERITH starter. Before the first delivery, initialize it with project-specific information:

./scripts/initialize.sh \
  --name "My Project" \
  --description "One-sentence product description" \
  --problem "The user problem this project addresses"

The initializer replaces the required project placeholders and removes the template sentinel. Do not add credentials, API keys, customer data, or production configuration to this repository.

This starter is technology-neutral. Select the application stack in the first architecture decision, then document the local setup and run commands here.

Run the baseline contract locally:

./ci/verify.sh

Add stack-specific lint, build, and test commands as the project takes shape.

Read and maintain the architecture overview. Record significant technical choices in architecture decisions.

Report vulnerabilities through the organization security policy. Never commit secrets; use a secure secret-management service when a deployment is introduced.

Follow the NOERITH contribution guide, code of conduct, and support policy.

• Default branch: main.
• Feature branches: feat/<short-name>.
• Fix branches: fix/<short-name>.
• Security branches: security/<short-name>.
• Use Conventional Commits and Semantic Versioning.
• Use pull requests for normal changes; review major dependency updates manually.
• Owner bypass is reserved for an emergency only.

GitHub Free note: organization rulesets can be configured but may not be enforced for private repositories. Follow this pull-request convention even where GitHub cannot enforce it.

This starter is licensed under the Apache License 2.0. Confirm the appropriate license before applying it to a product repository.