diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 00000000..cab6aae6 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,2 @@ +# Global review assignment +* @amoussa1229 diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 00000000..9d2d231b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,36 @@ +name: Bug Report +description: Report a defect or unexpected behavior. +labels: [bug] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to file a bug report. + - type: textarea + id: summary + attributes: + label: Summary + description: A concise description of the bug. + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: Reproduction + description: Steps to reproduce the behavior, including code or commands if applicable. + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected behavior + description: What you expected to happen. + validations: + required: true + - type: textarea + id: environment + attributes: + label: Environment + description: Python version, OS, and any relevant dependency versions. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..959ffa56 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Sea Haven Security + url: mailto:security@seahavenind.com + about: Report security concerns privately. diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 00000000..84f20c97 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,29 @@ +name: Feature Request +description: Propose a new feature or enhancement. +labels: [enhancement] +body: + - type: markdown + attributes: + value: | + Thanks for suggesting an improvement. + - type: textarea + id: summary + attributes: + label: Summary + description: What is the feature or enhancement? + validations: + required: true + - type: textarea + id: motivation + attributes: + label: Motivation + description: Why is this needed? What problem does it solve? + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Alternatives + description: Any alternative approaches you considered. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/task.yml b/.github/ISSUE_TEMPLATE/task.yml new file mode 100644 index 00000000..2f1f535d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/task.yml @@ -0,0 +1,29 @@ +name: Task +description: Track a maintenance, documentation, or engineering task. +labels: [task] +body: + - type: markdown + attributes: + value: | + Use this template for work that is not a bug or feature request. + - type: textarea + id: summary + attributes: + label: Summary + description: What needs to be done? + validations: + required: true + - type: textarea + id: acceptance + attributes: + label: Acceptance criteria + description: How will we know this task is complete? + validations: + required: true + - type: textarea + id: notes + attributes: + label: Notes + description: Any additional context, dependencies, or links. + validations: + required: false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..62df881b --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,15 @@ +## Summary + + + +## Validation + + + +## Tests + + + +## Notes + + diff --git a/README.md b/README.md index 343bda15..88b1058c 100644 --- a/README.md +++ b/README.md @@ -13,11 +13,12 @@