Skip to content

Commit 1fa84ac

Browse files
DA-344DA-344
committed
feat: Add .github data folder
1 parent 5bc49a6 commit 1fa84ac

7 files changed

Lines changed: 208 additions & 2 deletions

File tree

‎.github/CONTRIBUTING.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
## Contributing to discord.py
2+
[comment]: <> (Thanks to Rapptz -maybe, this is where i took inspiration from- for making this template I've adapted for my bot)
3+
4+
First off, thanks for taking the time to contribute. It makes the bot substantially better. :+1:
5+
6+
The following is a set of guidelines for contributing to the repository. These are guidelines, not hard rules.
7+
8+
## This is too much to read! I want to ask a question!
9+
10+
Generally speaking questions are better suited in our resources below.
11+
12+
- The official support server: https://discord.gg/m9UsWuaYDT
13+
- The GitHub issues page: https://github.com/SpaceBot-Development-Team/space/issues
14+
15+
Please try your best not to ask questions in our issue tracker. Most of them don't belong there unless they provide value to a larger audience.
16+
17+
## Good Bug Reports
18+
19+
Please be aware of the following things when filing bug reports.
20+
21+
1. Don't open duplicate issues. Please search your issue to see if it has been asked already. Duplicate issues will be closed.
22+
2. When filing a bug about exceptions or tracebacks, please include the *complete* traceback. Without the complete traceback the issue might be **unsolvable** and you will be asked to provide more information.
23+
3. Make sure to provide enough information to make the issue workable. The issue template will generally walk you through the process but they are enumerated here as well:
24+
- A **summary** of your bug report. This is generally a quick sentence or two to describe the issue in human terms.
25+
- Guidance on **how to reproduce the issue**. Ideally, this should have a small set of steps on how to reproduce this bug.
26+
- Tell us **what you expected to happen**. That way we can meet that expectation.
27+
- Tell us **what actually happens**. What ends up happening in reality? It's not helpful to say "it fails" or "it doesn't work". Say *how* it failed, does it hang? How are the expectations different from reality?
28+
29+
If the bug report is missing this information then it'll take us longer to fix the issue. We will probably ask for clarification, and barring that if no response was given then the issue will be closed.
30+
31+
## Submitting a Pull Request
32+
33+
Submitting a pull request is fairly simple, just make sure it focuses on a single aspect and doesn't manage to have scope creep and it's probably good to go. It would be incredibly lovely if the style is consistent to that found in the project. This project follows PEP-8 guidelines (mostly) with a column limit of 125.
34+
35+
### Git Commit Guidelines
36+
37+
- Use present tense (e.g. "Add feature" not "Added feature")
38+
- Limit all lines to 72 characters or less.
39+
- Reference issues or pull requests outside of the first line.
40+
- Please use the shorthand `#123` and not the full URL.
41+
42+
If you do not meet any of these guidelines, don't fret. Chances are they will be fixed upon rebasing but please do try to meet them to remove some of the workload.

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Bug Report
2+
description: Report broken or incorrect behaviour
3+
labels: unconfirmed bug
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: >
8+
Thanks for taking the time to fill out a bug.
9+
If you want real-time support, consider joining our Discord at https://discord.gg/m9UsWuaYDT instead.
10+
11+
Please note that this form is for bugs only!
12+
- type: input
13+
attributes:
14+
label: Summary
15+
description: A simple summary of your bug report
16+
validations:
17+
required: true
18+
- type: textarea
19+
attributes:
20+
label: Reproduction Steps
21+
description: >
22+
What you did to make it happen.
23+
validations:
24+
required: true
25+
- type: textarea
26+
attributes:
27+
label: Expected Results
28+
description: >
29+
What did you expect to happen?
30+
validations:
31+
required: true
32+
- type: textarea
33+
attributes:
34+
label: Actual Results
35+
description: >
36+
What actually happened?
37+
validations:
38+
required: true
39+
- type: checkboxes
40+
attributes:
41+
label: Checklist
42+
description: >
43+
Let's make sure you've properly done due diligence when reporting this issue!
44+
options:
45+
- label: I have searched the open issues for duplicates.
46+
required: true
47+
- type: textarea
48+
attributes:
49+
label: Additional Context
50+
description: If there is anything else to say, please do so here.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Ask a question
4+
about: Ask questions and discuss with other users of the library.
5+
url: https://github.com/SpaceBot-Development-Team/space/discussions
6+
- name: Discord Server
7+
about: Use our official Discord server to ask for help and questions as well.
8+
url: https://discord.gg/m9UsWuaYDT

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Feature Request
2+
description: Suggest a feature for the bot
3+
labels: feature request
4+
body:
5+
- type: input
6+
attributes:
7+
label: Summary
8+
description: >
9+
A short description of what your feature request is.
10+
validations:
11+
required: true
12+
- type: dropdown
13+
attributes:
14+
multiple: false
15+
label: What is this feature request for?
16+
options:
17+
- The bot
18+
- The documentation
19+
validations:
20+
required: true
21+
- type: textarea
22+
attributes:
23+
label: The Problem
24+
description: >
25+
What problem if your feature trying to solve?
26+
What becomes easier or possible when this feature is implemented?
27+
validations:
28+
required: true
29+
- type: textarea
30+
attributes:
31+
label: The Ideal Solution
32+
description: >
33+
What is your ideal solution to the problem?
34+
What would you like this feature to do?
35+
validations:
36+
required: true
37+
- type: textarea
38+
attributes:
39+
label: The Current Solution
40+
description: >
41+
What is the current solution to the problem, if any?
42+
validations:
43+
required: false
44+
- type: textarea
45+
attributes:
46+
label: Additional Context
47+
description: If there is anything else to say, please do so here.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
### Summary
2+
3+
<!-- What is this pull request for? Does it fix any issues? -->
4+
5+
## Checklist
6+
7+
<!-- Put an x inside [ ] to check it, like so: [x] -->
8+
9+
- [ ] If code changes were made, then they have been tested.
10+
- [ ] This PR fixes an issue.
11+
- [ ] This PR adds something new (e.g. new commands or modules).
12+
- [ ] This PR is a breaking change (e.g. commands or modules renamed or removed).
13+
- [ ] This PR is **not** a code change (e.g. documentation, docstrings, README, changelog, ...).
14+
- [ ] I have searched for duplicates.
15+
- [ ] If ``type: ignore``, ``pyright: ignore``, or similar, were used, then a comment explaining why was also left.
16+
- [ ] I have formatted the code using ``black==25.1.0``.

‎.github/workflows/lint.yml‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Lint
2+
3+
on:
4+
push:
5+
pull_request:
6+
types: [ opened, reopened, synchronize ]
7+
8+
jobs:
9+
check:
10+
runs-on: ubuntu-latest
11+
12+
name: check
13+
steps:
14+
- uses: actions/checkout@v3
15+
with:
16+
fetch-depth: 0
17+
18+
- name: Set up CPython
19+
uses: actions/setup-python@v4
20+
with:
21+
python-version: '3.12'
22+
23+
- name: Install dependencies
24+
id: install-deps
25+
run: |
26+
python -m pip install --upgrade pip setuptools wheel black==25.1.0 requests
27+
pip install -U -r requirements.txt
28+
29+
- name: Setup node.js
30+
uses: actions/setup-node@v3
31+
with:
32+
node-version: '16'
33+
34+
- name: Run PyRight
35+
uses: jakebailey/pyright-action@v1
36+
with:
37+
version: '1.1.394'
38+
warnings: false
39+
no-comments: true
40+
41+
- name: Run Black
42+
if: ${{ always() && steps.install-deps.outcome == 'success' }}
43+
run: |
44+
black --check cogs store bot.py errors.py main.py paginator.py utils.py

‎README.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,4 @@ through [this link](https://discord.com/api/oauth2/authorize?client_id=118850123
99

1010
# Contributing to Development
1111

12-
The only requirement is to have a good understanding of Python and **know what you are writing, meaning that any attempt to create a vulnerability, joke changes, or anything that does not benefit**
13-
**the bot will result in a contribution ban**.
12+
For more information on how to contribute, look at [CONTRIBUTING.md](/.github/CONTRIBUTING.md)

0 commit comments

Comments
 (0)