From 10bd7f7cb663335977525a5290298679090af2ed Mon Sep 17 00:00:00 2001 From: Naomi Carrigan Date: Mon, 10 Feb 2025 11:04:32 -0800 Subject: [PATCH] feat: set up org readme and contributor request form --- .gitea/issue_template/bug_report.yaml | 69 ---------------------- .gitea/issue_template/config.yml | 5 -- .gitea/issue_template/contributor.yml | 46 +++++++++++++++ .gitea/issue_template/feature_proposal.yml | 46 --------------- .gitea/issue_template/other.yml | 34 ----------- README.md | 44 +++++--------- 6 files changed, 62 insertions(+), 182 deletions(-) delete mode 100644 .gitea/issue_template/bug_report.yaml delete mode 100644 .gitea/issue_template/config.yml create mode 100644 .gitea/issue_template/contributor.yml delete mode 100644 .gitea/issue_template/feature_proposal.yml delete mode 100644 .gitea/issue_template/other.yml diff --git a/.gitea/issue_template/bug_report.yaml b/.gitea/issue_template/bug_report.yaml deleted file mode 100644 index bf17745..0000000 --- a/.gitea/issue_template/bug_report.yaml +++ /dev/null @@ -1,69 +0,0 @@ -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/.gitea/issue_template/config.yml b/.gitea/issue_template/config.yml deleted file mode 100644 index f1cdc86..0000000 --- a/.gitea/issue_template/config.yml +++ /dev/null @@ -1,5 +0,0 @@ -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/.gitea/issue_template/contributor.yml b/.gitea/issue_template/contributor.yml new file mode 100644 index 0000000..e47b63d --- /dev/null +++ b/.gitea/issue_template/contributor.yml @@ -0,0 +1,46 @@ +name: Contributor Access Request +description: Want to contribute to our projects? Request access here! +title: "Contributor Access Request: [Your Name]" +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: reason + attributes: + label: "Why do you want to become a contributor?" + description: "Please provide a brief explanation of why you would like to become a contributor to our projects." + validations: + required: true + - type: checkboxes + id: policy + attributes: + label: "Policy Agreements" + description: "By checking the boxes below, I agree to the following policies:" + options: + - label: "I understand that my access to this repository is a privilege, not a right, and may be revoked at any time." + validations: + required: true + - label: "I understand NHCarrigan's branching strategy as outlined in the readme, and agree that my branches will follow the naming conventions. I also agree that I will not push to another contributor's branch without their permission." + validations: + required: true + - label: "I have joined at least one of the [community platforms](https://chat.nhcarrigan.com) so that I can communicate about my work and stay up to date on the latest project information." + validations: + required: true diff --git a/.gitea/issue_template/feature_proposal.yml b/.gitea/issue_template/feature_proposal.yml deleted file mode 100644 index b3fae97..0000000 --- a/.gitea/issue_template/feature_proposal.yml +++ /dev/null @@ -1,46 +0,0 @@ -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/.gitea/issue_template/other.yml b/.gitea/issue_template/other.yml deleted file mode 100644 index 2f1335f..0000000 --- a/.gitea/issue_template/other.yml +++ /dev/null @@ -1,34 +0,0 @@ -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/README.md b/README.md index 47a840e..53d893f 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,27 @@ -# New Repository Template +# NHCarrigan's Code Repositories -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. +This website holds all of our source code. This particular organisation contains our public projects that are open for people to contribute to. -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. +## Instance Information -## Readme +This Gitea instance is specifically for NHCarrigan's use. This means: -Delete all of the above text (including this line), and uncomment the below text to use our standard readme template. +- You can create an account to use to report issues on our products +- You can NOT create your own repositories and host them on our instance +- You can NOT create your own organisations - +Make sure you have joined [one of our community platforms](https://chat.nhcarrigan.com)! This is not only a great way to connect with your fellow contributors and stay in the loop on our latest updates, but ensures you can reach us if you have questions or get stuck!