1- Guidelines for Contributing
2- ===========================
1+ #############################
2+ Guidelines for Contributing
3+ #############################
34
4- Code of Conduct
5- ---------------
5+ *****************
6+ Code of Conduct
7+ *****************
68
79This project is released with a `Contributor Code of Conduct `_. By participating in this
810project you agree to abide by its terms.
911
10- Creating an Issue
11- -----------------
12+ *******************
13+ Creating an Issue
14+ *******************
1215
13161. 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
17203. 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
2327One of the simplest ways to help with PRAW is by answering others questions. When
2428responding, always be positive. While something may be obvious to you, it likely is not
2529to the person asking the question.
2630
27- Creating Pull Requests
28- ----------------------
31+ ************************
32+ Creating Pull Requests
33+ ************************
2934
30351. 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
58639. 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
6470The PRAW team is always interested in expanding PRAW's active team member base with
6571proven contributors. If you are interested, please let us know. In general, we would
6672like to see you push a number of contributions before we add you on.
6773
68- Style Recommendations
69- ---------------------
74+ ***********************
75+ Style Recommendations
76+ ***********************
7077
7178To keep PRAW's source consistent, all contribution code must pass the ``pre_push.py ``
7279script. 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
7582look over the following list:
7683
7784Method 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
119127Please also read `Contributing to PRAW `_.
120128
0 commit comments