mirror of
https://github.com/Hessenuk/DiscordTickets.git
synced 2024-12-23 00:03:09 +02:00
.github
This commit is contained in:
parent
b0e29be1b5
commit
01f4bd0a13
76
.github/CODE_OF_CONDUCT.md
vendored
76
.github/CODE_OF_CONDUCT.md
vendored
@ -1,76 +0,0 @@
|
|||||||
# Contributor Covenant Code of Conduct
|
|
||||||
|
|
||||||
## Our Pledge
|
|
||||||
|
|
||||||
In the interest of fostering an open and welcoming environment, we as
|
|
||||||
contributors and maintainers pledge to making participation in our project and
|
|
||||||
our community a harassment-free experience for everyone, regardless of age, body
|
|
||||||
size, disability, ethnicity, sex characteristics, gender identity and expression,
|
|
||||||
level of experience, education, socio-economic status, nationality, personal
|
|
||||||
appearance, race, religion, or sexual identity and orientation.
|
|
||||||
|
|
||||||
## Our Standards
|
|
||||||
|
|
||||||
Examples of behavior that contributes to creating a positive environment
|
|
||||||
include:
|
|
||||||
|
|
||||||
* Using welcoming and inclusive language
|
|
||||||
* Being respectful of differing viewpoints and experiences
|
|
||||||
* Gracefully accepting constructive criticism
|
|
||||||
* Focusing on what is best for the community
|
|
||||||
* Showing empathy towards other community members
|
|
||||||
|
|
||||||
Examples of unacceptable behavior by participants include:
|
|
||||||
|
|
||||||
* The use of sexualized language or imagery and unwelcome sexual attention or
|
|
||||||
advances
|
|
||||||
* Trolling, insulting/derogatory comments, and personal or political attacks
|
|
||||||
* Public or private harassment
|
|
||||||
* Publishing others' private information, such as a physical or electronic
|
|
||||||
address, without explicit permission
|
|
||||||
* Other conduct which could reasonably be considered inappropriate in a
|
|
||||||
professional setting
|
|
||||||
|
|
||||||
## Our Responsibilities
|
|
||||||
|
|
||||||
Project maintainers are responsible for clarifying the standards of acceptable
|
|
||||||
behavior and are expected to take appropriate and fair corrective action in
|
|
||||||
response to any instances of unacceptable behavior.
|
|
||||||
|
|
||||||
Project maintainers have the right and responsibility to remove, edit, or
|
|
||||||
reject comments, commits, code, wiki edits, issues, and other contributions
|
|
||||||
that are not aligned to this Code of Conduct, or to ban temporarily or
|
|
||||||
permanently any contributor for other behaviors that they deem inappropriate,
|
|
||||||
threatening, offensive, or harmful.
|
|
||||||
|
|
||||||
## Scope
|
|
||||||
|
|
||||||
This Code of Conduct applies both within project spaces and in public spaces
|
|
||||||
when an individual is representing the project or its community. Examples of
|
|
||||||
representing a project or community include using an official project e-mail
|
|
||||||
address, posting via an official social media account, or acting as an appointed
|
|
||||||
representative at an online or offline event. Representation of a project may be
|
|
||||||
further defined and clarified by project maintainers.
|
|
||||||
|
|
||||||
## Enforcement
|
|
||||||
|
|
||||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
||||||
reported by contacting the project team at contact@eartharoid.me. All
|
|
||||||
complaints will be reviewed and investigated and will result in a response that
|
|
||||||
is deemed necessary and appropriate to the circumstances. The project team is
|
|
||||||
obligated to maintain confidentiality with regard to the reporter of an incident.
|
|
||||||
Further details of specific enforcement policies may be posted separately.
|
|
||||||
|
|
||||||
Project maintainers who do not follow or enforce the Code of Conduct in good
|
|
||||||
faith may face temporary or permanent repercussions as determined by other
|
|
||||||
members of the project's leadership.
|
|
||||||
|
|
||||||
## Attribution
|
|
||||||
|
|
||||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
|
||||||
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
|
|
||||||
|
|
||||||
[homepage]: https://www.contributor-covenant.org
|
|
||||||
|
|
||||||
For answers to common questions about this code of conduct, see
|
|
||||||
https://www.contributor-covenant.org/faq
|
|
95
.github/CONTRIBUTING.md
vendored
95
.github/CONTRIBUTING.md
vendored
@ -1,95 +0,0 @@
|
|||||||
# Contributing
|
|
||||||
|
|
||||||
**Table of contents**
|
|
||||||
|
|
||||||
- [Contributing](#contributing)
|
|
||||||
- [Submitting a bug report](#submitting-a-bug-report)
|
|
||||||
- [Submitting a feature request](#submitting-a-feature-request)
|
|
||||||
- [Creating a pull request](#creating-a-pull-request)
|
|
||||||
- [Contributing code](#contributing-code)
|
|
||||||
- [Translating](#translating)
|
|
||||||
- [Updating documentation](#updating-documentation)
|
|
||||||
- [Website](#website)
|
|
||||||
- [JSDoc](#jsdoc)
|
|
||||||
|
|
||||||
Thank you for considering contributing to Discord Tickets.
|
|
||||||
|
|
||||||
Before contributing, please read the [code of conduct](CODE_OF_CONDUCT.md), which all contributors must follow.
|
|
||||||
|
|
||||||
You don't need to write code to contribute; all contributions are welcome and encouraged. You could:
|
|
||||||
|
|
||||||
- [Submit a bug report](#submitting-a-bug-report) issue
|
|
||||||
- Help with bug triage
|
|
||||||
- [Request a new feature (or an improvement to an existing feature)](#submitting-a-feature-request)
|
|
||||||
- [Improve documentation](#updating-documentation) (the [website](https://discordtickets.app), or JSDoc comments)
|
|
||||||
- [Help translate](#translating)
|
|
||||||
- Create a tutorial (a video or page on the docs)
|
|
||||||
- [Answer someone's question in Discussions](https://github.com/discord-tickets/bot/discussions/categories/support-q-a?discussions_q=category%3A%22Support+%28Q%26A%29%22+is%3Aunanswered)
|
|
||||||
- Respond to an issue or pull request
|
|
||||||
|
|
||||||
If you want to contribute but don't know how, and this file doesn't answer your questions, [start a discussion](https://github.com/discord-tickets/bot/discussions/new) or [join the Discord support & community server](https://go.eartharoid.me/discord) to ask for guidance.
|
|
||||||
|
|
||||||
**Issues are for:**
|
|
||||||
|
|
||||||
- Bug reports
|
|
||||||
- Requesting changes to existing features
|
|
||||||
|
|
||||||
Please label your issues appropriately.
|
|
||||||
|
|
||||||
**Discussions are for:**
|
|
||||||
|
|
||||||
- Support (also on [Discord](https://go.eartharoid.me/discord))
|
|
||||||
- General questions (also on [Discord](https://go.eartharoid.me/discord))
|
|
||||||
- Requesting new features
|
|
||||||
|
|
||||||
Please read ["Welcome to Discord Tickets Discussions!"](https://github.com/discord-tickets/bot/discussions/77) before starting a discussion!
|
|
||||||
|
|
||||||
## Submitting a bug report
|
|
||||||
|
|
||||||
Issues should be used to report bugs. If you have found a bug, check to see if it has already been reported or resolved. If it hasn't, you can [create a new issue](https://github.com/discord-tickets/bot/issues/new/choose) using the "Bug report" template. Please include as much information as possible in your report.
|
|
||||||
|
|
||||||
## Submitting a feature request
|
|
||||||
|
|
||||||
To request a new feature, [start a new discussion](https://github.com/discord-tickets/bot/discussions/new?category=Ideas) under the Ideas category so other members of the community can discuss the request and vote on it.
|
|
||||||
|
|
||||||
If you would like to request changes to an existing feature, it may be better to [create an issue](https://github.com/discord-tickets/bot/issues/new) instead (use the `enhancement` label).
|
|
||||||
|
|
||||||
## Creating a pull request
|
|
||||||
|
|
||||||
To edit the documentation, translate, or contribute code to this project, you will need to [create a new pull request](https://github.com/discord-tickets/bot/compare). For large changes, you should **consider creating an issue** (or commenting on an existing one) first, as it could save you some time.
|
|
||||||
|
|
||||||
You should name your commits using [**this commit message format**](https://github.com/angular/material/blob/master/.github/CONTRIBUTING.md#-commit-message-format).
|
|
||||||
|
|
||||||
### Contributing code
|
|
||||||
|
|
||||||
Any code changes should be accompanied by any necessary documentation changes.
|
|
||||||
|
|
||||||
You should install the ESLint extension in your editor help you follow the code style.
|
|
||||||
|
|
||||||
- Use single quotes
|
|
||||||
- Classes should be named in PascalCase
|
|
||||||
- Functions should be named in camelCase
|
|
||||||
- Variables and constants should be named in snake_case
|
|
||||||
|
|
||||||
### Translating
|
|
||||||
|
|
||||||
Please try to keep the meaning of the translation as close to the original as possible. If you want to change the meaning, you can customise your local files after.
|
|
||||||
|
|
||||||
Create an account on [i18n.discordtickets.app](https://i18n.discordtickets.app/) to get started. Ask on [Discord](https://go.eartharoid.me/discord) or in the [discussions](https://github.com/discord-tickets/bot/discussions) to get a new language added.
|
|
||||||
|
|
||||||
### Updating documentation
|
|
||||||
|
|
||||||
#### Website
|
|
||||||
|
|
||||||
The documentation is written in Markdown, with extensions for additional features. See the [Material for MkDocs Reference](https://squidfunk.github.io/mkdocs-material/reference/abbreviations/) for details.
|
|
||||||
|
|
||||||
Please install a Markdown linting extension in your editor.
|
|
||||||
|
|
||||||
If you would like to see a live preview of your changes you can install MkDocs locally after cloning the repository (requires python).
|
|
||||||
|
|
||||||
1. Install with `pip install -r requirements.txt`
|
|
||||||
2. Run `mkdocs serve`
|
|
||||||
|
|
||||||
#### JSDoc
|
|
||||||
|
|
||||||
Feel free to improve or add JSDoc comments in the JavaScript files.
|
|
1
.github/FUNDING.yml
vendored
1
.github/FUNDING.yml
vendored
@ -1 +0,0 @@
|
|||||||
ko_fi: eartharoid
|
|
23
.github/ISSUE_TEMPLATE/bug_report.md
vendored
23
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@ -1,23 +0,0 @@
|
|||||||
---
|
|
||||||
name: Bug report
|
|
||||||
about: Report a bug
|
|
||||||
title: "[BUG] "
|
|
||||||
labels: bug
|
|
||||||
assignees: ''
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Describe the bug**
|
|
||||||
<!-- A clear and concise description of what the bug is -->
|
|
||||||
|
|
||||||
**To reproduce**
|
|
||||||
<!-- Steps to reproduce the behaviour -->
|
|
||||||
|
|
||||||
**Expected behavior**
|
|
||||||
<!-- A clear and concise description of what you expected to happen -->
|
|
||||||
|
|
||||||
**Screenshots**
|
|
||||||
<!-- If applicable, add screenshots to help explain your problem -->
|
|
||||||
|
|
||||||
**Additional context**
|
|
||||||
<!-- Add any other context about the problem here -->
|
|
8
.github/ISSUE_TEMPLATE/config.yml
vendored
8
.github/ISSUE_TEMPLATE/config.yml
vendored
@ -1,8 +0,0 @@
|
|||||||
blank_issues_enabled: true
|
|
||||||
contact_links:
|
|
||||||
- name: GitHub Discussions
|
|
||||||
url: https://github.com/discord-tickets/bot/discussions
|
|
||||||
about: Request new features, share ideas and guides, ask for help, or just talk.
|
|
||||||
- name: Discord support server
|
|
||||||
url: https://go.eartharoid.me/discord
|
|
||||||
about: The best place to go for help installing or using Discord Tickets
|
|
10
.github/PULL_REQUEST_TEMPLATE.md
vendored
10
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -1,6 +1,6 @@
|
|||||||
<!--
|
<!--
|
||||||
Thank you for contributing to Discord Tickets.
|
Thank you for contributing to Discord Tickets.
|
||||||
If you haven't already, please read the CONTRIBUTING file (.github/CONTRIBUTING.md) before creating a pull request.
|
If you haven't already, please read the CONTRIBUTING guidelines (https://github.com/discord-tickets/.github/blob/main/CONTRIBUTING.md) before creating a pull request.
|
||||||
Unless this pull request is for something minor like a fixing a typo, you should create an issue first.
|
Unless this pull request is for something minor like a fixing a typo, you should create an issue first.
|
||||||
-->
|
-->
|
||||||
|
|
||||||
@ -10,8 +10,8 @@
|
|||||||
|
|
||||||
- [ ] This includes major changes (breaking changes)
|
- [ ] This includes major changes (breaking changes)
|
||||||
- [ ] This includes minor changes (minimal usage changes, minor new features)
|
- [ ] This includes minor changes (minimal usage changes, minor new features)
|
||||||
- [ ] This includes patches (bug or typo fixes)
|
- [ ] This includes patches (bug fixes)
|
||||||
- [ ] This includes **only** documentation changes
|
- [ ] This does not change functionality at all (code refactoring, comments)
|
||||||
|
|
||||||
**Is this related to an issue?**
|
**Is this related to an issue?**
|
||||||
|
|
||||||
@ -25,6 +25,6 @@
|
|||||||
|
|
||||||
<!-- Select **all that apply** by replacing the space with an `x`: `[X]` -->
|
<!-- Select **all that apply** by replacing the space with an `x`: `[X]` -->
|
||||||
|
|
||||||
- [ ] I have updated any necessary documentation
|
- [ ] I have updated related documentation (if necessary)
|
||||||
- [ ] My changes use consistent code style
|
- [ ] My changes use consistent code style
|
||||||
- [ ] My changes are tested and work
|
- [ ] My changes have been tested and confirmed to work
|
||||||
|
8
.github/SECURITY.md
vendored
8
.github/SECURITY.md
vendored
@ -5,11 +5,11 @@
|
|||||||
Release versions that will receive security updates.
|
Release versions that will receive security updates.
|
||||||
|
|
||||||
| Version | Supported |
|
| Version | Supported |
|
||||||
| ------- | -------------- |
|
| ------- | --------- |
|
||||||
| 3.x | ✅ |
|
| 3.x | ✅ |
|
||||||
| 2.x | ⚠️ Deprecated |
|
| 2.x | ❌ |
|
||||||
| < 2.0 | ❌ |
|
| 1.x | ❌ |
|
||||||
|
|
||||||
## Reporting a vulnerability
|
## Reporting a vulnerability
|
||||||
|
|
||||||
If you find a vulnerability, please [email me](mailto:contact@eartharoid.me).
|
If you find a vulnerability, please send an email to [contact@discordtickets.app](mailto:contact@discordtickets.app).
|
||||||
|
Loading…
Reference in New Issue
Block a user