From 6b121400394252601150668300d571143add4b6d Mon Sep 17 00:00:00 2001 From: nhcarrigan Date: Wed, 2 Oct 2024 19:02:09 +0000 Subject: [PATCH] Initial commit --- .forgejo/issue_template/bug_report.yaml | 69 +++++++++++++++ .forgejo/issue_template/config.yml | 5 ++ .forgejo/issue_template/feature_proposal.yml | 46 ++++++++++ .forgejo/issue_template/other.yml | 34 +++++++ .forgejo/pull_request_template.yml | 93 ++++++++++++++++++++ .gitattributes | 8 ++ CODE_OF_CONDUCT.md | 3 + CONTRIBUTING.md | 3 + LICENSE.md | 5 ++ PRIVACY.md | 3 + README.md | 39 ++++++++ SECURITY.md | 3 + TERMS.md | 3 + 13 files changed, 314 insertions(+) create mode 100644 .forgejo/issue_template/bug_report.yaml create mode 100644 .forgejo/issue_template/config.yml create mode 100644 .forgejo/issue_template/feature_proposal.yml create mode 100644 .forgejo/issue_template/other.yml create mode 100644 .forgejo/pull_request_template.yml create mode 100644 .gitattributes create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE.md create mode 100644 PRIVACY.md create mode 100644 README.md create mode 100644 SECURITY.md create mode 100644 TERMS.md diff --git a/.forgejo/issue_template/bug_report.yaml b/.forgejo/issue_template/bug_report.yaml new file mode 100644 index 0000000..6deb616 --- /dev/null +++ b/.forgejo/issue_template/bug_report.yaml @@ -0,0 +1,69 @@ +name: 🐛 Bug Report +description: Something isn't working as expected? Let us know! +title: '[BUG] - ' +labels: + - "🚦 status: awaiting triage" +body: + - type: checkboxes + id: attestations + attributes: + label: Attestations + description: "By checking the boxes below, I certify that:" + options: + - label: "I have read and agree to the [Code of Conduct](https://docs.nhcarrigan.com/community/coc/)" + validations: + required: true + - label: I have read and agree to the [Community Guidelines](https://docs.nhcarrigan.com/community/guide/). + validations: + required: true + - label: I have confirmed that the issue I am opening is unique, and has not already been reported (whether closed or not). + validations: + required: true + - label: I have reviewed the [Security Policy](https://docs.nhcarrigan.com/legal/security/) and have determined that this is not a security vulnerability. + validations: + required: true + - type: textarea + id: description + attributes: + label: "Describe your Issue:" + description: A clear and concise description of what the bug is. + validations: + required: true + - type: dropdown + id: reproduce + attributes: + label: Can you reproduce this issue? + options: + - Yes + - No + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: "Steps to Reproduce:" + description: Steps to reproduce the behavior. + - type: input + id: os + attributes: + label: "Operating System:" + description: The operating system you are using, including the version/build number. + validations: + required: true +# Remove this section for non-web apps. + - type: input + id: browser + attributes: + label: "Browser:" + description: The browser you are using, including the version number. + validations: + required: true + - type: dropdown + attributes: + label: Are you willing and able to contribute a fix? + options: + - Yes + - No + validations: + required: true + diff --git a/.forgejo/issue_template/config.yml b/.forgejo/issue_template/config.yml new file mode 100644 index 0000000..f1cdc86 --- /dev/null +++ b/.forgejo/issue_template/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: "Discord" + url: "https://chat.nhcarrigan.com" + about: "Chat with us directly." \ No newline at end of file diff --git a/.forgejo/issue_template/feature_proposal.yml b/.forgejo/issue_template/feature_proposal.yml new file mode 100644 index 0000000..d833b94 --- /dev/null +++ b/.forgejo/issue_template/feature_proposal.yml @@ -0,0 +1,46 @@ +name: 💭 Feature Proposal +description: Have an idea for how we can improve? Share it here! +title: '[FEAT] - ' +labels: + - "🚦 status: awaiting triage" +body: + - type: checkboxes + id: attestations + attributes: + label: Attestations + description: "By checking the boxes below, I certify that:" + options: + - label: "I have read and agree to the [Code of Conduct](https://docs.nhcarrigan.com/community/coc/)" + validations: + required: true + - label: I have read and agree to the [Community Guidelines](https://docs.nhcarrigan.com/community/guide/). + validations: + required: true + - label: I have confirmed that the issue I am opening is unique, and has not already been reported (whether closed or not). + validations: + required: true + - label: I have reviewed the [Security Policy](https://docs.nhcarrigan.com/legal/security/) and have determined that this is not a security vulnerability. + validations: + required: true + - type: textarea + id: description + attributes: + label: "Describe your Idea:" + description: A clear and concise description of the feature you would like added. + validations: + required: true + - type: textarea + id: solution + attributes: + label: "What problem does this feature solve?" + description: Why are you requesting this feature? How would it improve your experience with the product? + validations: + required: true + - type: dropdown + attributes: + label: Are you willing and able to contribute this feature? + options: + - Yes + - No + validations: + required: true diff --git a/.forgejo/issue_template/other.yml b/.forgejo/issue_template/other.yml new file mode 100644 index 0000000..680e7a7 --- /dev/null +++ b/.forgejo/issue_template/other.yml @@ -0,0 +1,34 @@ +name: ❓ Other Issue +description: I have something that is neither a bug nor a feature request. +title: '[OTHER] - ' +labels: + - "🚦 status: awaiting triage" +body: + - type: checkboxes + id: attestations + attributes: + label: Attestations + description: "By checking the boxes below, I certify that:" + options: + - label: "I have read and agree to the [Code of Conduct](https://docs.nhcarrigan.com/community/coc/)" + validations: + required: true + - label: I have read and agree to the [Community Guidelines](https://docs.nhcarrigan.com/community/guide/). + validations: + required: true + - label: I have confirmed that the issue I am opening is unique, and has not already been reported (whether closed or not). + validations: + required: true + - label: I have reviewed the [Security Policy](https://docs.nhcarrigan.com/legal/security/) and have determined that this is not a security vulnerability. + validations: + required: true + - label: This is not a feature request or bug report that I am mis-filing to avoid the issue template. + validations: + required: true + - type: textarea + id: description + attributes: + label: "Share your thoughts:" + description: Why are you opening this issue? + validations: + required: true diff --git a/.forgejo/pull_request_template.yml b/.forgejo/pull_request_template.yml new file mode 100644 index 0000000..37d43f4 --- /dev/null +++ b/.forgejo/pull_request_template.yml @@ -0,0 +1,93 @@ +name: "Pull Request Template" +about: "Template for pulls" +labels: + - "🔍 pull: ready for review" +body: + - type: textarea + id: explain + attributes: + label: "Explanation" + description: "Briefly explain WHY this pull request is necessary. Do not explain what it does, as that's evidenced in the changes." + validations: + required: true + - type: input + id: issue + attributes: + label: "Issue" + description: "My pull request relates to or resolves the following issue number:" + validations: + required: true + is_number: true + - type: checkboxes + id: attestations + attributes: + label: Attestations + description: "By checking the boxes below, I certify that:" + options: + - label: "I have read and agree to the [Code of Conduct](https://docs.nhcarrigan.com/community/coc/)" + validations: + required: true + - label: I have read and agree to the [Community Guidelines](https://docs.nhcarrigan.com/community/guide/). + validations: + required: true + - label: My contribution complies with the [Contributor Covenant](https://docs.nhcarrigan.com/dev/covenant/). + validations: + required: true + - type: checkboxes + id: dependencies + attributes: + label: Dependencies + description: "My pull request adds or updates dependencies, so:" + options: + - label: I have pinned the dependencies to a specific patch version. + validations: + required: false + - type: checkboxes + id: style + attributes: + label: Style + description: "My contribution adheres to the following style guidelines:" + options: + - label: I have run the linter and resolved any errors. + validations: + required: true + - label: My pull request uses an appropriate title, matching the conventional commit standards. + validations: + required: true + - label: My scope of feat/fix/chore/etc. correctly matches the nature of changes in my pull request. + validations: + required: true + - type: checkboxes + id: tests + attributes: + label: Tests + description: "My contribution includes the following tests:" + options: + - label: My contribution adds new code, and I have added tests to cover it. + validations: + required: false + - label: My contribution modifies existing code, and I have updated the tests to reflect these changes. + validations: + required: false + - label: All new and existing tests pass locally with my changes. + validations: + required: true + - label: Code coverage remains at or above the configured threshold. + validations: + required: true + - type: input + id: docs + attributes: + label: Documentation + description: "I have made the following PR to update the documentation site with my changes:" + validations: + required: true + - type: dropdown + id: version + attributes: + label: Versioning + description: "I believe my changes should be included in the following release:" + options: + - "Major - My pull request introduces a breaking change." + - "Minor - My pull request introduces a new non-breaking feature." + - "Patch - My pull request introduces bug fixes ONLY." diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..2bffe04 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,8 @@ +# Auto detect text files and perform LF normalization +* text eol=LF +*.ts text +*.spec.ts text + +# Ignore binary files >:( +*.png binary +*.jpg binary \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..a3bbfe2 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,3 @@ +# Code of Conduct + +Our Code of Conduct can be found here: https://docs.nhcarrigan.com/#/coc diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f67101e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,3 @@ +# Contributing + +Our contributing guidelines can be found here: https://docs.nhcarrigan.com/#/contributing diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..5424732 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,5 @@ +# License + +This software is licensed under our [global software license](https://docs.nhcarrigan.com/#/license). + +Copyright held by Naomi Carrigan. diff --git a/PRIVACY.md b/PRIVACY.md new file mode 100644 index 0000000..96791d1 --- /dev/null +++ b/PRIVACY.md @@ -0,0 +1,3 @@ +# Privacy Policy + +Our privacy policy can be found here: https://docs.nhcarrigan.com/#/privacy diff --git a/README.md b/README.md new file mode 100644 index 0000000..47a840e --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# New Repository Template + +This template contains all of our basic files for a new GitHub repository. There is also a handy workflow that will create an issue on a new repository made from this template, with a checklist for the steps we usually take in setting up a new repository. + +If you're starting a Node.JS project with TypeScript, we have a [specific template](https://github.com/naomi-lgbt/nodejs-typescript-template) for that purpose. + +## Readme + +Delete all of the above text (including this line), and uncomment the below text to use our standard readme template. + + diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..bb3fc2d --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,3 @@ +# Security Policy + +Our security policy can be found here: https://docs.nhcarrigan.com/#/security diff --git a/TERMS.md b/TERMS.md new file mode 100644 index 0000000..f556156 --- /dev/null +++ b/TERMS.md @@ -0,0 +1,3 @@ +# Terms of Service + +Our Terms of Service can be found here: https://docs.nhcarrigan.com/#/terms