Skip to content

Commit 7d379f4

Browse files
authored
chore: release 4.1.0 (#542)
chore: release 4.1.0
2 parents e836e50 + 155c55b commit 7d379f4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+5082
-1963
lines changed

.github/FUNDING.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
# These are supported funding model platforms
22

33
github: [goverfl0w]
4+
open_collective: discordinteractions

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Discord server
4+
url: https://discord.gg/KkgMBVuEkx
5+
about: Join our Discord server for support.

.github/ISSUE_TEMPLATE/report-bug.md

Lines changed: 0 additions & 40 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/report-bug.yml

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
name: Report Bug
2+
description: Create an Issue to report a bug with/about the library.
3+
title: "[BUG] "
4+
labels: ["bug"]
5+
assignees:
6+
- goverfl0w
7+
- DeltaXWizard
8+
- EdVraz
9+
body:
10+
- type: markdown
11+
id: thanks
12+
attributes:
13+
value: |
14+
Thank you for taking the time to fill out this bug report!
15+
We rely on users to tell us things that we might not find on our own,
16+
and your help is greatly valued by the team and others contributing.
17+
- type: textarea
18+
id: process
19+
attributes:
20+
label: Describe the bug.
21+
description: Please give us an in-depth description of the bug you are having.
22+
placeholder: When trying to use feature X, I was unable to make task Y work.
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: steps
27+
attributes:
28+
label: List the steps.
29+
description: Please give us a step-by-step process of how you were able to produce this.
30+
placeholder: |
31+
1. Import the module in Python.
32+
2. Create a client variable for the library.
33+
3. Try creating a slash command.
34+
4. See the traceback error given in the terminal or logger file.
35+
validations:
36+
required: true
37+
- type: textarea
38+
id: expectation
39+
attributes:
40+
label: What you expected.
41+
description: Please tell us what you expect for this to do when it ran.
42+
placeholder: When I create a slash command, the command should be created and functional.
43+
validations:
44+
required: true
45+
- type: textarea
46+
id: result
47+
attributes:
48+
label: What you saw.
49+
description: Please tell us what you found when you actually ran this.
50+
placeholder: Instead, I received this traceback error given from my Python terminal.
51+
value: |
52+
Instead, I received this traceback error given from my Python terminal:
53+
```
54+
Traceback (most recent call last):
55+
File "A:\Amogus\Python\interactions-bot\main.py", line 6
56+
raise SussyBaka("your code doesn't work, silly!")
57+
^
58+
59+
SussyBaka: your code doesn't work, silly!
60+
```
61+
validations:
62+
required: true
63+
- type: dropdown
64+
id: version
65+
attributes:
66+
label: What version of the library did you use?
67+
multiple: false
68+
options:
69+
- release
70+
- stable
71+
- unstable
72+
validations:
73+
required: true
74+
- type: checkboxes
75+
id: accept
76+
attributes:
77+
label: Code of Conduct
78+
description: By submitting this Issue, you agree to follow our [contribution requirements.](https://github.com/interactions-py/library/blob/unstable/CONTRIBUTING.rst)
79+
options:
80+
- label: I agree to follow the contribution requirements.
81+
required: true

.github/ISSUE_TEMPLATE/request-feature.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Request Feature
33
about: Create an Issue to suggest or propose implementing something(s).
44
title: "[REQUEST] "
55
labels: documentation, enhancement
6-
assignees: goverfl0w
6+
assignees: goverfl0w, DeltaXWizard, EdVraz
77

88
---
99

.github/workflows/ci.yml

Lines changed: 0 additions & 21 deletions
This file was deleted.

.github/workflows/python-publish.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@ jobs:
2222
twine upload dist/*
2323
on:
2424
release:
25-
types: [created]
25+
types: [released]

.pre-commit-config.yaml

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,22 @@ repos:
55
- id: requirements-txt-fixer
66
name: Requirements
77
types: [file]
8+
exclude_types: ['image']
89
- id: debug-statements
910
name: Debugging
1011
language: python
1112
types: [file, python]
13+
exclude_types: ['image']
1214
- id: trailing-whitespace
1315
name: Trailing Whitespace
1416
language: python
1517
types: [file]
18+
exclude_types: ['image']
1619
- id: end-of-file-fixer
1720
name: EOF Newlines
1821
language: python
1922
types: [file]
23+
exclude_types: ['image']
2024
- id: check-yaml
2125
name: YAML Structure
2226
language: python
@@ -25,7 +29,7 @@ repos:
2529
- id: check-merge-conflict
2630
name: Merge Conflicts
2731
- repo: https://github.com/psf/black
28-
rev: 21.12b0
32+
rev: 22.1.0
2933
hooks:
3034
- id: black
3135
name: Black Formatting
@@ -47,3 +51,9 @@ repos:
4751
name: isort Formatting
4852
language: python
4953
types: [file, python]
54+
ci:
55+
autoupdate_branch: "unstable"
56+
autofix_prs: true
57+
autoupdate_commit_msg: "ci: weekly check."
58+
autoupdate_schedule: weekly
59+
autofix_commit_msg: "ci: correct from checks."

CONTRIBUTING.rst

Lines changed: 35 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,11 @@ error may be produced:
2020
.. code-block:: python
2121
2222
import interactions
23-
from logging import DEBUG
23+
from logging import basicConfig, DEBUG
2424
25-
bot = interactions.Client(token="...", log_level=DEBUG) # you can also use -1.
25+
basicConfig(level=DEBUG)
26+
27+
bot = interactions.Client(token="...")
2628
2729
bot.start()
2830
@@ -32,28 +34,49 @@ the `Code of Conduct`_ from their documentation.
3234
Where to start
3335
--------------
3436
Our contributions start with an **Issue**. The issue should explain what the problem you're having is.
35-
Issues are our way and methodology of tracking bugs that may be occuring with this library. In order
36-
to create create in relevance to the issue, you start a **Pull Request**. Linking the issue in this
37+
Issues are our way and methodology of tracking bugs that may be occuring with this library. Every contributor
38+
must start with an Issue, as this helps numerous contributors and developers on various teams keep track of
39+
requests, bugs and miscellaneous details.
40+
41+
Issue specifications
42+
********************
43+
Whenever there is an Issue created, they must follow the according criterion:
44+
45+
- An Issue must not be a duplicate of an existing one.
46+
- A bug Issue must have all fields filled out.
47+
- A request Issue must have support from a pre-determined amount of users.
48+
- A miscellanous Issue must:
49+
- Target a third-party repository if it is an issue correlated between the two.
50+
- Specify external issues that tie into library installation or performance.
51+
52+
Failure to comply to these factors will result in the Issue being closed with a comment and/or label.
53+
Some Issues may be closed by the discretion of varying development teams for reasons that exclude
54+
these factors.
55+
56+
Pull Request specifications
57+
***************************
58+
In order to create create in relevance to the issue, you start a **Pull Request**. Linking the issue in this
3759
(known as a PR) allows us to easily identify what bugs have been correlated with the code requesting
3860
to be changed in the source, and allow other developers to contribute where needed.
3961

4062
When a PR is made, you **must** be targeting the ``unstable`` branch. This is our development branch
4163
that we use whenever we're working on any bugfixing, breaking changes and/or overall new features. Our
4264
development workflow for changes is from this branch to ``stable``, and then from there to a release.
4365

44-
Pull Request specifications
45-
***************************
46-
A pull request should adhere to these following requirements:
66+
A pull request must additionally adhere to these following requirements:
4767

48-
- Each git commit made on your forked project should use `conventional commits`_.
49-
- The pull request should always be up-to-date with ``unstable``.
68+
- Each git commit made on your fork must use `conventional commits`_.
69+
- The pull request must be up-to-date with ``unstable`` before requesting a review.
70+
- A ``pre-commit`` commit must exist and pass *all* checks before requesting a review.
71+
- A review must be requested from at least one developer. Please target ``@interactions-py/core`` for this.
5072

5173
Recognizing contributors
5274
------------------------
5375
When a PR is successfully merged into one of the development branches, the GitHub user will automatically
54-
be added to the contributor list of the repository. Additionally, we also provide a role in our support
55-
server for contributors. (You will be notified if you are eligible for this.) The git commit history on a
56-
file will also subsequently be updated by GitHub to include your user signature.
76+
be added to the contributor list of the repository. Additionally, at the discretion of the core development
77+
team, it is possible to earn a role in our support server for contributors. (You will be notified if you are
78+
eligible for this.) The git commit history on a file will also subsequently be updated by GitHub to include
79+
your user signature.
5780

5881
.. _Code of Conduct: https://github.com/discord/discord-api-docs/blob/master/CODE_OF_CONDUCT.md
5982
.. _conventional commits: https://www.conventionalcommits.org/en/v1.0.0/

docs/_static/OAuth2_left.png

17.5 KB
Loading

0 commit comments

Comments
 (0)