generated from nhcarrigan/template
feat: add template files (#6)
This adds all the template files that seem to be missing. Reviewed-on: https://codeberg.org/nhcarrigan/mod-bot/pulls/6 Reviewed-by: Naomi the Technomancer <naomi-lgbt@noreply.codeberg.org> Co-authored-by: A Cottrill <a.rcottrill521@gmail.com> Co-committed-by: A Cottrill <a.rcottrill521@gmail.com>
This commit is contained in:
Naomi the Technomancer
parent
15a8aa21be
commit
73c4f2c168
69
.forgejo/issue_template/bug_report.yml
Normal file
69
.forgejo/issue_template/bug_report.yml
Normal file
@ -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
|
||||||
|
|
||||||
5
.forgejo/issue_template/config.yml
Normal file
5
.forgejo/issue_template/config.yml
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
blank_issues_enabled: false
|
||||||
|
contact_links:
|
||||||
|
- name: "Discord"
|
||||||
|
url: "https://chat.nhcarrigan.com"
|
||||||
|
about: "Chat with us directly."
|
||||||
46
.forgejo/issue_template/feature_proposal.yml
Normal file
46
.forgejo/issue_template/feature_proposal.yml
Normal file
@ -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
|
||||||
34
.forgejo/issue_template/other.yml
Normal file
34
.forgejo/issue_template/other.yml
Normal file
@ -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
|
||||||
93
.forgejo/pull_request_template.yml
Normal file
93
.forgejo/pull_request_template.yml
Normal file
@ -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."
|
||||||
26
README.md
26
README.md
@ -1 +1,25 @@
|
|||||||
Mod bot is private for reasons
|
# Mod Bot
|
||||||
|
|
||||||
|
My personal mod bot
|
||||||
|
|
||||||
|
## Feedback and Bugs
|
||||||
|
|
||||||
|
If you have feedback or a bug report, please feel free to open a GitHub issue!
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
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