Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 25 additions & 17 deletions .github/CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
Guidelines for Contributing
===========================
#############################
Guidelines for Contributing
#############################

Code of Conduct
---------------
*****************
Code of Conduct
*****************

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

Creating an Issue
-----------------
*******************
Creating an Issue
*******************

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

Responding to Issues
--------------------
**********************
Responding to Issues
**********************

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

Creating Pull Requests
----------------------
************************
Creating Pull Requests
************************

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

Becoming a Team Member
----------------------
************************
Becoming a Team Member
************************

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

Style Recommendations
---------------------
***********************
Style Recommendations
***********************

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

Method Order within a Class
~~~~~~~~~~~~~~~~~~~~~~~~~~~
===========================

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

Expand Down Expand Up @@ -113,8 +120,9 @@ Method Order within a Class
def instance_method(self):
pass

See Also
--------
**********
See Also
**********

Please also read `Contributing to PRAW`_.

Expand Down
4 changes: 2 additions & 2 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@ repos:
- id: ruff
args: [ --exit-non-zero-on-fix, --fix ]
files: ^(praw/.*.py)$
rev: v0.13.3
rev: v0.14.6

- repo: https://github.com/LilSpazJoekp/docstrfmt
hooks:
- id: docstrfmt
rev: v1.11.1
rev: v2.0.0

- repo: https://github.com/MarcoGorelli/auto-walrus
hooks:
Expand Down
20 changes: 12 additions & 8 deletions AUTHORS.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
Maintainers
===========
#############
Maintainers
#############

- Bryce Boe <bbzbryce@gmail.com> `@bboe <https://github.com/bboe>`_
- Joe RH <jarhill0@gmail.com> `@jarhill0 <https://github.com/jarhill0>`_
- Joel Payne <lilspazjoekp@gmail.com> `@LilSpazJoekp <https://github.com/LilSpazJoekp>`_

Documentation Contributors
==========================
############################
Documentation Contributors
############################

- Dale Cudmore <dalecudmore@gmail.com> `@DCuddies <https://github.com/DCuddies>`_
- Zhifu Ge <zhifu@me.com> `@zhifuge <https://github.com/zhifuge>`_
Expand Down Expand Up @@ -34,13 +36,15 @@ Documentation Contributors
- u/gkanor `@gkanor <https://github.com/gkanor>`_
- Add "Name <email (optional)> and github profile link" above this line.

Logo Creator
============
##############
Logo Creator
##############

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

Source Contributors
===================
#####################
Source Contributors
#####################

- Ethan Dalool <edalool@yahoo.com> `@voussoir <https://github.com/voussoir>`_
- William McKinnerney <me@williammck.net> `@williammck <https://github.com/williammck>`_
Expand Down
Loading
Loading