generated from nhcarrigan/template
feat: set up org readme and contributor request form
This commit is contained in:
parent
aecb2da285
commit
10bd7f7cb6
@ -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
|
|
||||||
|
|
@ -1,5 +0,0 @@
|
|||||||
blank_issues_enabled: false
|
|
||||||
contact_links:
|
|
||||||
- name: "Discord"
|
|
||||||
url: "https://chat.nhcarrigan.com"
|
|
||||||
about: "Chat with us directly."
|
|
46
.gitea/issue_template/contributor.yml
Normal file
46
.gitea/issue_template/contributor.yml
Normal file
@ -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
|
@ -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
|
|
@ -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
|
|
44
README.md
44
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
|
||||||
|
|
||||||
<!-- # Project Name
|
## Contributor Information
|
||||||
|
|
||||||
Project Description
|
We gladly welcome contributions to our products! However, because our instance does not allow users to create and host their own repositories, you'll need access to create branches on our repositories directly.
|
||||||
|
|
||||||
## Live Version
|
To obtain this access, please [fill out the form](https://git.nhcarrigan.com/nhcarrigan/.profile/issues/new?template=.gitea%2fissue_template%2fcontributor.yaml). Once approved, you'll have access to branch directly on our repositories.
|
||||||
|
|
||||||
This page is currently deployed. [View the live website.]
|
Before you start working on code, make sure you've given our [Contributor Guide](https://docs.nhcarrigan.com/dev/contributing/) a read. Additionally, some things you need to follow:
|
||||||
|
|
||||||
## Feedback and Bugs
|
- Branches should be prefixed with your username, e.g. `naomi/feat/add-readme`
|
||||||
|
- NEVER push to another contributor's branch without their explicit consent
|
||||||
|
- You will not have access to push directly to `main` - you should ALWAYS create a pull request for our team to review
|
||||||
|
|
||||||
If you have feedback or a bug report, please feel free to open a GitHub issue!
|
## Stay Informed
|
||||||
|
|
||||||
## Contributing
|
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!
|
||||||
|
|
||||||
If you would like to contribute to the project, you may create a Pull Request containing your proposed changes and we will review it as soon as we are able! Please review our [contributing guidelines](CONTRIBUTING.md) first.
|
|
||||||
|
|
||||||
## Code of Conduct
|
|
||||||
|
|
||||||
Before interacting with our community, please read our [Code of Conduct](CODE_OF_CONDUCT.md).
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
This software is licensed under our [global software license](https://docs.nhcarrigan.com/#/license).
|
|
||||||
|
|
||||||
Copyright held by Naomi Carrigan.
|
|
||||||
|
|
||||||
## Contact
|
|
||||||
|
|
||||||
We may be contacted through our [Chat Server](http://chat.nhcarrigan.com) or via email at `contact@nhcarrigan.com`. -->
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user