Skip to content

Commit 6fb83cc

Browse files
LilSpazJoekpgithub-actions[bot]
authored andcommitted
Update pre-commit hooks
1 parent 2e09ecb commit 6fb83cc

File tree

148 files changed

+763
-525
lines changed

Some content is hidden

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

148 files changed

+763
-525
lines changed

.github/CONTRIBUTING.rst

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
1-
Guidelines for Contributing
2-
===========================
1+
#############################
2+
Guidelines for Contributing
3+
#############################
34

4-
Code of Conduct
5-
---------------
5+
*****************
6+
Code of Conduct
7+
*****************
68

79
This project is released with a `Contributor Code of Conduct`_. By participating in this
810
project you agree to abide by its terms.
911

10-
Creating an Issue
11-
-----------------
12+
*******************
13+
Creating an Issue
14+
*******************
1215

1316
1. Please do not create issues for questions you have. The appropriate location for such
1417
questions is `r/redditdev`_ or via Slack_.
@@ -17,15 +20,17 @@ Creating an Issue
1720
3. Please use GitHub's issue search feature to look for already reported issues before
1821
reporting your own.
1922

20-
Responding to Issues
21-
--------------------
23+
**********************
24+
Responding to Issues
25+
**********************
2226

2327
One of the simplest ways to help with PRAW is by answering others questions. When
2428
responding, always be positive. While something may be obvious to you, it likely is not
2529
to the person asking the question.
2630

27-
Creating Pull Requests
28-
----------------------
31+
************************
32+
Creating Pull Requests
33+
************************
2934

3035
1. If you are fixing an already filed issue, please indicate your intentions by
3136
commenting on the issue. This act will hopefully minimize any duplicate work.
@@ -58,15 +63,17 @@ Creating Pull Requests
5863
9. Feel free to check on the status of your pull request periodically by adding a
5964
comment.
6065

61-
Becoming a Team Member
62-
----------------------
66+
************************
67+
Becoming a Team Member
68+
************************
6369

6470
The PRAW team is always interested in expanding PRAW's active team member base with
6571
proven contributors. If you are interested, please let us know. In general, we would
6672
like to see you push a number of contributions before we add you on.
6773

68-
Style Recommendations
69-
---------------------
74+
***********************
75+
Style Recommendations
76+
***********************
7077

7178
To keep PRAW's source consistent, all contribution code must pass the ``pre_push.py``
7279
script. GitHub Actions will enforce the passing of the automated tests, as well as style
@@ -75,7 +82,7 @@ with much of PEP8 and PEP257 there are a few things that it does not enforce. Pl
7582
look over the following list:
7683

7784
Method Order within a Class
78-
~~~~~~~~~~~~~~~~~~~~~~~~~~~
85+
===========================
7986

8087
- Group method names by type and order the groups like so:
8188

@@ -113,8 +120,9 @@ Method Order within a Class
113120
def instance_method(self):
114121
pass
115122
116-
See Also
117-
--------
123+
**********
124+
See Also
125+
**********
118126

119127
Please also read `Contributing to PRAW`_.
120128

.pre-commit-config.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@ repos:
2222
- id: ruff
2323
args: [ --exit-non-zero-on-fix, --fix ]
2424
files: ^(praw/.*.py)$
25-
rev: v0.13.3
25+
rev: v0.14.6
2626

2727
- repo: https://github.com/LilSpazJoekp/docstrfmt
2828
hooks:
2929
- id: docstrfmt
30-
rev: v1.11.1
30+
rev: v2.0.0
3131

3232
- repo: https://github.com/MarcoGorelli/auto-walrus
3333
hooks:

AUTHORS.rst

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
1-
Maintainers
2-
===========
1+
#############
2+
Maintainers
3+
#############
34

45
- Bryce Boe <[email protected]> `@bboe <https://github.com/bboe>`_
56
- Joe RH <[email protected]> `@jarhill0 <https://github.com/jarhill0>`_
67
- Joel Payne <[email protected]> `@LilSpazJoekp <https://github.com/LilSpazJoekp>`_
78

8-
Documentation Contributors
9-
==========================
9+
############################
10+
Documentation Contributors
11+
############################
1012

1113
- Dale Cudmore <[email protected]> `@DCuddies <https://github.com/DCuddies>`_
1214
- Zhifu Ge <[email protected]> `@zhifuge <https://github.com/zhifuge>`_
@@ -34,13 +36,15 @@ Documentation Contributors
3436
- u/gkanor `@gkanor <https://github.com/gkanor>`_
3537
- Add "Name <email (optional)> and github profile link" above this line.
3638

37-
Logo Creator
38-
============
39+
##############
40+
Logo Creator
41+
##############
3942

4043
- kungming2 `@kungming2 <https://github.com/kungming2>`_
4144

42-
Source Contributors
43-
===================
45+
#####################
46+
Source Contributors
47+
#####################
4448

4549
- Ethan Dalool <[email protected]> `@voussoir <https://github.com/voussoir>`_
4650
- William McKinnerney <[email protected]> `@williammck <https://github.com/williammck>`_

0 commit comments

Comments
 (0)