Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 22 additions & 2 deletions documentation/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,28 @@ We will use the feature-branch workflow with all merges handled through PRs.
* ```bugfix/short-name```
* Rebase your working branch with main, and often, before submitting a PR (simpler conflict resolution)
## Issues & Planning
Explain how to file issues, required templates/labels, estimation, and
triage/assignment practices.
Issue titles should start with the following tags to designate intent:
- `FEAT:` New feature request.
- Include problem and feature description within issue description field.
- Include note of requirement ID where applicable (ex: `Requirement ID: REQ-005`).
- `BUG:` Bug report.
- Include problem description.
- `DOC:` Documentation changes.
- Brief description of what needs to be changed or added.

Example:
```
FEAT: Example Issue

Requirement ID: REQ-XXX

Problem Desciption:
- Brief explanation of why this is important

Feature Description:
- Brief explanation of expected implementation
```

## Commit Messages
We will use the [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/) format for clarity and traceability

Expand Down