Skip to content

Commit 5bee7e3

Browse files
authored
Merge pull request #415 from Pycord-Development/contrib-guidelines
Update contribution guidelines
2 parents 7e4ce97 + 6f568da commit 5bee7e3

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,11 @@ If the bug report is missing this information then it'll take us longer to fix t
3434

3535
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.
3636

37+
## Use of "type: ignore" comments
38+
In some cases, it might be necessary to ignore type checker warnings for one reason or another.
39+
If that is that case, it is **required** that a comment is left explaining why you are
40+
deciding to ignore type checking warnings.
41+
3742
### Licensing
3843

3944
By submitting a pull request, you agree that; 1) You hold the copyright on all submitted code inside said pull request; 2) You agree to transfer all rights to the owner of this repository, and; 3) If you are found to be in fault with any of the above, we shall not be held responsible in any way after the pull request has been merged.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88

99
- [ ] If code changes were made then they have been tested.
1010
- [ ] I have updated the documentation to reflect the changes.
11+
- [ ] If `type: ignore` comments were used, a comment is also left explaining why
1112
- [ ] This PR fixes an issue.
1213
- [ ] This PR adds something new (e.g. new method or parameters).
1314
- [ ] This PR is a breaking change (e.g. methods or parameters removed/renamed)

0 commit comments

Comments
 (0)