Skip to content

Commit

Permalink
feat: add initial organization documentation and templates (#1)
Browse files Browse the repository at this point in the history
Signed-off-by: Nathan Klick <[email protected]>
  • Loading branch information
nathanklick authored Sep 9, 2024
1 parent 22797cb commit c31c63d
Show file tree
Hide file tree
Showing 11 changed files with 1,352 additions and 0 deletions.
37 changes: 37 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
###################################
##### Global Protection Rule ######
###################################
# NOTE: This rule is overriden by the more specific rules below. This is the catch-all rule for all files not covered by the more specific rules below.
* @swirldslabs/release-engineering-managers @swirldslabs/product-security

#########################
##### Core Files ######
#########################

# NOTE: Must be placed last to ensure enforcement over all other rules

# Protection Rules for Github Configuration Files and Actions Workflows
/.github/ @swirldslabs/release-engineering-managers
/.github/workflows/ @swirldslabs/release-engineering-managers @swirldslabs/product-security @swirldslabs/devops-ci


# Codacy Tool Configurations
/config/ @swirldslabs/release-engineering-managers
.remarkrc @swirldslabs/release-engineering-managers

# Semantic Release Configuration
.releaserc @swirldslabs/release-engineering-managers

# Self-protection for root CODEOWNERS files (this file should not exist and should definitely require approval)
/CODEOWNERS @swirldslabs/release-engineering-managers

# Protect the repository root files
/README.md @swirldslabs/release-engineering-managers
**/LICENSE @swirldslabs/release-engineering-managers

# CodeCov configuration
**/codecov.yml @swirldslabs/release-engineering-managers

# Git Ignore definitions
**/.gitignore @swirldslabs/release-engineering-managers
**/.gitignore.* @swirldslabs/release-engineering-managers
52 changes: 52 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: Bug Report
description: File a bug report
title: "<Please write a short description of what didn't work for you here>"
labels: ["Bug", "Pending Triage"]
body:
- type: input
id: bom-cli-version
attributes:
label: Bill of Materials, Application, or CLI Version
description: Which version of the BOM, Application, or CLI software are you using?
placeholder: |
ex. 0.18.2 or git commit ID
The bill of materials version can be found in your Gradle or Maven
build configuration. The CLI version can be found by using the `--version` switch.
- type: textarea
id: actual-behavior
attributes:
label: Describe the bug
description: Also tell us, what did happen?
placeholder: A clear and concise description of what happened.
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Describe the expected behavior
description: Also tell us, what did you expect to happen?
placeholder: A clear and concise description of what the expected behavior is.
validations:
required: true
- type: textarea
id: reproduction-steps
attributes:
label: To Reproduce
description: Steps to reproduce the behavior
render: markdown
placeholder: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: |
_Add any other context about the problem here._
_Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in._
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_enhancement.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Feature Enhancement
description: Enhance an existing feature
title: "<Please write a brief description of the feature enhancement here>"
labels: ["Feature Enhancement", "Pending Triage"]
body:
- type: textarea
id: target-feature
attributes:
label: Feature to Enhance
description: Which existing feature would you like to enhance?
render: markdown
placeholder: |
_A clear and concise description of the feature you want to enhance._
validations:
required: true
- type: textarea
id: enhancement-description
attributes:
label: Requested Enhancement
description: What would you like to enhance or change about this feature?
render: markdown
placeholder: |
_A clear and concise description of what you want to happen._
validations:
required: true
- type: textarea
id: feature-justification
attributes:
label: Business Need
description: Why is this needed?
render: markdown
placeholder: |
_Please provide a clear and concise description of the business need for this enhancement. This will help us prioritize the feature request._
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: |
_Add any other context or screenshots about the feature request here._
_Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in._
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: New Feature
description: Request a new feature
title: "<Please write a brief description of the new feature here>"
labels: ["New Feature", "Pending Triage"]
body:
- type: textarea
id: feature-description
attributes:
label: Requested Feature
description: What would you like added?
render: markdown
placeholder: |
_A clear and concise description of what you want to happen._
Note: Feature requests to integrate vendor specific cloud tools (e.g. awscli, gcloud-sdk, azure-cli) will likely be rejected as the Full Stack Testing (FST) Suite aims to be vendor agnostic.
validations:
required: true
- type: textarea
id: feature-justification
attributes:
label: Business Need
description: Why is this needed?
render: markdown
placeholder: |
_Please provide a clear and concise description of the business need for this feature. This will help us prioritize the feature request._
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: |
_Add any other context or screenshots about the feature request here._
_Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in._
Loading

0 comments on commit c31c63d

Please sign in to comment.