-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: standardize repo to template and update README.md (#20)
* chore: standardize repo to template and update README.md * Update README.md Co-authored-by: Micah Nagel <micah.nagel@defenseunicorns.com> * Update README.md Co-authored-by: Micah Nagel <micah.nagel@defenseunicorns.com> * Update README.md Co-authored-by: Micah Nagel <micah.nagel@defenseunicorns.com> * Update CONTRIBUTING.md Co-authored-by: Micah Nagel <micah.nagel@defenseunicorns.com> * Update contributing guidelines + renovate * Update security.md * remove values * update commitlint --------- Co-authored-by: Micah Nagel <micah.nagel@defenseunicorns.com>
- Loading branch information
Showing
13 changed files
with
231 additions
and
107 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
adr |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: 'possible-bug 🐛' | ||
assignees: '' | ||
--- | ||
|
||
### Environment | ||
Device and OS: | ||
App/package versions: | ||
Kubernetes distro being used: | ||
Other: | ||
|
||
### Steps to reproduce | ||
1. | ||
|
||
### Expected result | ||
|
||
### Actual Result | ||
|
||
### Visual Proof (screenshots, videos, text, etc) | ||
|
||
### Severity/Priority | ||
|
||
### Additional Context | ||
Add any other context or screenshots about the technical debt here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: 'enhancement ✨' | ||
assignees: '' | ||
--- | ||
|
||
### Is your feature request related to a problem? Please describe. | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
### Describe the solution you'd like | ||
|
||
- **Given** a state | ||
- **When** an action is taken | ||
- **Then** something happens | ||
|
||
### Describe alternatives you've considered | ||
(optional) A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
### Additional context | ||
Add any other context or screenshots about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
--- | ||
name: Tech debt | ||
about: Record something that should be investigated or refactored in the future. | ||
title: '' | ||
labels: 'tech-debt 💳' | ||
assignees: '' | ||
--- | ||
|
||
### Describe what should be investigated or refactored | ||
A clear and concise description of what should be changed/researched. Ex. This piece of the code is not DRY enough [...] | ||
|
||
### Links to any relevant code | ||
(optional) i.e. - https://github.com/defenseunicorns/uds-package-mattermost/blob/main/README.md?plain=1#L1 | ||
|
||
### Additional context | ||
Add any other context or screenshots about the technical debt here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
## Description | ||
|
||
... | ||
|
||
## Related Issue | ||
|
||
Fixes # | ||
<!-- or --> | ||
Relates to # | ||
|
||
## Type of change | ||
|
||
- [ ] Bug fix (non-breaking change which fixes an issue) | ||
- [ ] New feature (non-breaking change which adds functionality) | ||
- [ ] Other (security config, docs update, etc) | ||
|
||
## Checklist before merging | ||
|
||
- [ ] Test, docs, adr added or updated as needed | ||
- [ ] [Contributor Guide Steps](https://github.com/defenseunicorns/uds-package-mattermost/blob/main/CONTRIBUTING.md#developer-workflow) followed |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
name: Scorecards supply-chain security | ||
on: | ||
# Only the default branch is supported. | ||
branch_protection_rule: | ||
schedule: | ||
- cron: '30 1 * * 6' | ||
push: | ||
branches: [ "main" ] | ||
|
||
# Declare default permissions as read only. | ||
permissions: read-all | ||
|
||
jobs: | ||
analysis: | ||
name: Scorecards analysis | ||
runs-on: ubuntu-latest | ||
permissions: | ||
# Needed to upload the results to code-scanning dashboard. | ||
security-events: write | ||
# Used to receive a badge. | ||
id-token: write | ||
|
||
steps: | ||
- name: "Checkout code" | ||
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 | ||
with: | ||
persist-credentials: false | ||
|
||
- name: "Run analysis" | ||
uses: ossf/scorecard-action@0864cf19026789058feabb7e87baa5f140aac736 # v2.3.1 | ||
with: | ||
results_file: results.sarif | ||
results_format: sarif | ||
repo_token: ${{ secrets.SCORECARD_READ_TOKEN }} | ||
publish_results: true | ||
|
||
# Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF | ||
# format to the repository Actions tab. | ||
- name: "Upload artifact" | ||
uses: actions/upload-artifact@c7d193f32edcb7bfad88892161225aeda64e9392 # v4.0.0 | ||
with: | ||
name: SARIF file | ||
path: results.sarif | ||
retention-days: 5 | ||
|
||
# Upload the results to GitHub's code scanning dashboard. | ||
- name: "Upload to code-scanning" | ||
uses: github/codeql-action/upload-sarif@012739e5082ff0c22ca6d6ab32e07c36df03c4a4 # v3.22.12 | ||
with: | ||
sarif_file: results.sarif |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,27 +1,5 @@ | ||
# Welcome to the Matter Operator UDS Capability | ||
# Welcome to the Mattermost UDS Package | ||
|
||
Thank you for your interest in this Defense Unicorns UDS Capability! | ||
Thank you for your interest in this Defense Unicorns UDS Package! | ||
|
||
This document describes the process and requirements for contributing to this UDS Capability. | ||
|
||
## Developer Experience | ||
|
||
Continuous Delivery is core to our development philosophy. Check out [https://minimumcd.org](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 SWF. | ||
|
||
* 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 | ||
This package is part of Defense Unicorns' UDS Software Factory and follows the contributing guidelines outlined in that repositories' [CONTRIBUTING.md](https://github.com/defenseunicorns/uds-software-factory/blob/main/CONTRIBUTING.md) file. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# Security Policy | ||
|
||
## Supported Versions | ||
|
||
As [UDS Software Factory](https://github.com/defenseunicorns/uds-software-factory) has not yet reached v1.0.0, only the current latest minor release is supported. | ||
|
||
## Reporting a Vulnerability | ||
|
||
Please email `security-notice [at] defenseunicorns.com` to report a vulnerability. If you are unable to disclose details via email, please let us know and we can coordinate alternate communications. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# 1. Record architecture decisions | ||
|
||
Date: 2024-02-04 | ||
|
||
## Status | ||
|
||
Accepted | ||
|
||
## Context | ||
|
||
> NOTE: | ||
> | ||
> This file was automatically created when we used [adr-tools](https://github.com/npryce/adr-tools) to initialize the document log in the repo. ADRs on ADRs are a little silly, but it does give a lightweight way to direct the reader over to our contributor guide that has a lot more information. | ||
We need to record the architectural decisions made on this project. | ||
|
||
## Decision | ||
|
||
We will use Architecture Decision Records, as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions), with a couple of small tweaks. See the [Documentation section in the Contributor guide](../CONTRIBUTING.md#documentation) for full details. | ||
|
||
## Consequences | ||
|
||
See Michael Nygard's article, linked above. For a lightweight ADR toolset, see Nat Pryce's [adr-tools](https://github.com/npryce/adr-tools). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# NUMBER. TITLE | ||
|
||
Date: DATE | ||
|
||
## Status | ||
|
||
STATUS | ||
|
||
## Context | ||
|
||
The issue motivating this decision, and any context that influences or constrains the decision. | ||
|
||
## Decision | ||
|
||
The change that we're proposing or have agreed to implement. | ||
|
||
## Consequences | ||
|
||
What becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters