Skip to content

Latest commit

 

History

History
59 lines (40 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

59 lines (40 loc) · 2.25 KB
Raw

Welcome to the [NAME] UDS Capability

Thank you for your interest in this Defense Unicorns UDS Capability!

This document describes the process and requirements for contributing to this UDS Capability.

Table of Contents

  1. Developer Experience
  2. Definition of Done
  3. Getting Started
  4. Submitting a Pull Request
  5. PR Requirements
  6. Contact

Developer Experience

Continuous Delivery is core to our development philosophy. Check out https://minimumcd.org for a good baseline agreement on what that means.

Specifically:

  • We do trunk-based development (main) with short-lived feature branches that originate from the trunk, get merged into the trunk, and are deleted after the merge
  • We don't merge code into main that isn't releasable
  • We perform automated testing on all changes before they get merged to main
  • Continuous integration (CI) pipeline tests are definitive
  • We create immutable release artifacts

Definition of Done

We apply these general principles to all User Stories and activities contributing to the UDS.

  • Automated continuous integration (CI) pipeline tests pass
  • CI pipeline tests have been updated to meet system changes
  • Changes are peer reviewed
  • Acceptance criteria is met
  • Documentation is updated to reflect what changed

Getting Started

TBD

Submitting a Pull Request

  1. Create an Issue: For significant changes, please create an issue first, describing the problem or feature proposal. Trivial fixes do not require an issue.
  2. Commit Your Changes: Make your changes and commit them. All commits must be signed.
  3. Run Tests: Ensure that your changes pass all tests.
  4. Push Your Branch: Push your branch to your fork on GitHub.
  5. Create a Pull Request: Open a pull request against the main branch of the Capability repository. Please make sure that your PR passes all CI checks.

PR Requirements

  • PRs must be against the main branch.
  • PRs must pass CI checks.
  • All commits must be signed.
  • PRs should have a related issue, except for trivial fixes.

Contact

For any questions or concerns, please open an issue on GitHub or contact the maintainers.