mirror of
https://github.com/Hessenuk/DiscordTickets.git
synced 2025-09-05 17:51:27 +03:00
Set up for v3
This commit is contained in:
16
.github/CONTRIBUTING.md
vendored
16
.github/CONTRIBUTING.md
vendored
@@ -4,26 +4,20 @@
|
||||
|
||||
### Submitting a bug report
|
||||
|
||||
To submit a bug report, please use the "Bug report" template when creating a [new issue](https://github.com/eartharoid/DiscordTickets/issues/new/choose). Describe the bug in as much detail as possible, including how to reproduce the problem, using screenshots or code snippets if possible. Check that someone hasn't already filed an issue before creating another, you can comment on it if you want.
|
||||
To submit a bug report, please use the "Bug report" template when creating a [new issue](https://github.com/eartharoid/DiscordTickets/issues/new/choose). Describe the bug in as much detail as possible, including how to reproduce the problem, using screenshots or code snippets if possible. Check that someone else hasn't already created a similar first.
|
||||
|
||||
### Submitting a feature request
|
||||
|
||||
To submit a new feature request, please use the "Feature request" template when creating a [new issue](https://github.com/eartharoid/DiscordTickets/issues/new/choose).
|
||||
~~To submit a new feature request, please use the "Feature request" template when creating a [new issue](https://github.com/eartharoid/DiscordTickets/issues/new/choose).~~
|
||||
|
||||
You can request new features on [Feedbacky](https://app.feedbacky.net/b/dsctickets/).
|
||||
|
||||
### Submitting other issues
|
||||
|
||||
For issues not related to feature requests or bugs, you can [create a blank issue](https://github.com/eartharoid/DiscordTickets/issues/new). Please give us as much information as possible. If you just want to talk, you can join the [Discord server](https://github.com/eartharoid/DiscordTickets#support).
|
||||
For issues not related to feature requests or bugs, you can [create a blank issue](https://github.com/eartharoid/DiscordTickets/issues/new). Please give us as much information as possible. If you just want to talk (if you need help or have questions), you can join the [Discord server](https://go.eartharoid.me/discord) or use the [Discussions tab](https://github.com/eartharoid/DiscordTickets/discussions).
|
||||
|
||||
## Submitting a pull request
|
||||
|
||||
To contribute code to this project, create a new [pull request](https://github.com/eartharoid/DiscordTickets/pulls). For anything other than patches (bug fixes, documentation or minor code changes that have no affect on usage), such as a new feature, please create a [new issue](https://github.com/eartharoid/DiscordTickets/issues/new/choose) first, describing what you intend to change and why. Please ensure you update the documentation if needed.
|
||||
|
||||
When contributing, you should follow the same code style already used throughout, to ensure code is consistent.
|
||||
|
||||
1. Use single quote marks (`'`) when possible
|
||||
2. Template literals are preferred
|
||||
3. Commas should always have a space after them
|
||||
4. Use tabs, not spaces, and always indent
|
||||
5. Use arrow functions
|
||||
|
||||
**Note**: Create `user/dev.env` and `user/dev.config.js` for testing.
|
||||
|
18
.github/ISSUE_TEMPLATE/bug_report.md
vendored
18
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@@ -1,23 +1,23 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Report an issue or bug
|
||||
title: ''
|
||||
labels: ''
|
||||
about: Report a bug
|
||||
title: '[BUG] '
|
||||
labels: 'bug'
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Describe the bug**
|
||||
A clear and concise description of what the bug is.
|
||||
<!-- A clear and concise description of what the bug is -->
|
||||
|
||||
**To Reproduce**
|
||||
Steps to reproduce the behaviour:
|
||||
**To reproduce**
|
||||
<!-- Steps to reproduce the behaviour -->
|
||||
|
||||
**Expected behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
<!-- A clear and concise description of what you expected to happen -->
|
||||
|
||||
**Screenshots**
|
||||
If applicable, add screenshots to help explain your problem.
|
||||
<!-- If applicable, add screenshots to help explain your problem -->
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the problem here.
|
||||
<!-- Add any other context about the problem here -->
|
||||
|
18
.github/ISSUE_TEMPLATE/feature_request.md
vendored
18
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@@ -1,20 +1,24 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
title: ''
|
||||
labels: ''
|
||||
title: '[FEATURE] '
|
||||
labels: 'feature_request'
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
A clear and concise description of what the problem is.
|
||||
<!--
|
||||
Note that you can now submit feature requests on Feedbacky: https://app.feedbacky.net/b/dsctickets
|
||||
-->
|
||||
|
||||
**Is your feature request related to a problem?**
|
||||
<!-- A clear and concise description of what the problem is. Reference any relevant issues. -->
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen.
|
||||
<!-- A clear and concise description of what you want to happen. -->
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
|
||||
|
||||
**Additional context**
|
||||
Add any other context or screenshots about the feature request here.
|
||||
<!-- Add any other context or screenshots about the feature request here. -->
|
||||
|
16
.github/PULL_REQUEST_TEMPLATE.md
vendored
16
.github/PULL_REQUEST_TEMPLATE.md
vendored
@@ -1,22 +1,28 @@
|
||||
<!--
|
||||
Please read the CONTRIBUTING file (.github/CONTRIBUTING.md) before creating a pull request.
|
||||
Unless you are doing something small like fixing a typo, please create an issue first!
|
||||
-->
|
||||
|
||||
#### Information
|
||||
|
||||
> Check one
|
||||
<!-- Please select **one** by replacing the space with an `x`: `[X]` -->
|
||||
|
||||
- [ ] This includes major changes (breaking changes)
|
||||
- [ ] This includes minor changes (minimal usage changes, minor new features)
|
||||
- [ ] This includes patches (bug fixes, documentation changes etc)
|
||||
- [ ] This includes patches (bug or typo fixes)
|
||||
- [ ] This is includes **only** documentation changes
|
||||
|
||||
#### Is this related to an issue?
|
||||
|
||||
> Reference any issues here
|
||||
<!-- Reference any issues here -->
|
||||
|
||||
#### Changes made
|
||||
|
||||
> Describe your changes
|
||||
<!-- Describe your changes -->
|
||||
|
||||
#### Confirmations
|
||||
|
||||
> Check all that apply
|
||||
<!-- Select **all that apply** by replacing the space with an `x`: `[X]` -->
|
||||
|
||||
- [ ] I have updated any necessary documentation
|
||||
- [ ] This uses consistent code style
|
||||
|
15
.github/SECURITY.md
vendored
15
.github/SECURITY.md
vendored
@@ -1,14 +1,15 @@
|
||||
# Security Policy
|
||||
# Security policy
|
||||
|
||||
## Supported Versions
|
||||
## Supported versions
|
||||
|
||||
Release versions that will receive security updates.
|
||||
|
||||
| Version | Supported |
|
||||
| ------- | ------------------ |
|
||||
| 2.x | ✅ |
|
||||
| < 2.0 | ❌ |
|
||||
| Version | Supported |
|
||||
| ------- | -------------- |
|
||||
| 3.x | ✅ |
|
||||
| 2.x | ⚠️ Deprecated |
|
||||
| < 2.0 | ❌ |
|
||||
|
||||
## Reporting a Vulnerability
|
||||
## Reporting a vulnerability
|
||||
|
||||
If you find a vulnerability, please [email me](mailto:contact@eartharoid.me).
|
||||
|
15
.github/workflows/deploy-docs.yml
vendored
Normal file
15
.github/workflows/deploy-docs.yml
vendored
Normal file
@@ -0,0 +1,15 @@
|
||||
name: Build and deploy docs
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
jobs:
|
||||
deploy:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/setup-python@v2
|
||||
with:
|
||||
python-version: 3.x
|
||||
- run: pip install -r requirements.txt
|
||||
- run: mkdocs gh-deploy --force
|
Reference in New Issue
Block a user