Skip to content

Commit fe3d690

Browse files
committed
Add sections for Reporting Issues and Support to docs.
1 parent d7bc5e5 commit fe3d690

File tree

3 files changed

+68
-21
lines changed

3 files changed

+68
-21
lines changed

README.rst

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -143,40 +143,48 @@ Containers`_.
143143
Documentation
144144
-------------
145145

146-
Complete documentation including performance comparisons is available at
146+
Complete documentation for `Sorted Containers`_ is available at
147147
http://www.grantjenks.com/docs/sortedcontainers/
148148

149149
User Guide
150150
..........
151151

152-
For those wanting more details, this part of the documentation describes
153-
introduction, implementation, performance, and development.
152+
The user guide provides an introduction to `Sorted Containers`_ and extensive
153+
performance comparisons and analysis.
154154

155155
- `Introduction`_
156156
- `Performance Comparison`_
157157
- `Load Factor Performance Comparison`_
158158
- `Runtime Performance Comparison`_
159159
- `Simulated Workload Performance Comparison`_
160-
- `Implementation Details`_
161160
- `Performance at Scale`_
162-
- `Developing and Contributing`_
163-
- `Release History`_
164161

165162
.. _`Introduction`: http://www.grantjenks.com/docs/sortedcontainers/introduction.html
166163
.. _`Performance Comparison`: http://www.grantjenks.com/docs/sortedcontainers/performance.html
167164
.. _`Load Factor Performance Comparison`: http://www.grantjenks.com/docs/sortedcontainers/performance-load.html
168165
.. _`Runtime Performance Comparison`: http://www.grantjenks.com/docs/sortedcontainers/performance-runtime.html
169166
.. _`Simulated Workload Performance Comparison`: http://www.grantjenks.com/docs/sortedcontainers/performance-workload.html
170-
.. _`Implementation Details`: http://www.grantjenks.com/docs/sortedcontainers/implementation.html
171167
.. _`Performance at Scale`: http://www.grantjenks.com/docs/sortedcontainers/performance-scale.html
172-
.. _`Developing and Contributing`: http://www.grantjenks.com/docs/sortedcontainers/development.html
168+
169+
Community Guide
170+
...............
171+
172+
The community guide provides information on the development of `Sorted
173+
Containers`_ along with support, implementation, and history details.
174+
175+
- `Development and Support`_
176+
- `Implementation Details`_
177+
- `Release History`_
178+
179+
.. _`Development and Support`: http://www.grantjenks.com/docs/sortedcontainers/development.html
180+
.. _`Implementation Details`: http://www.grantjenks.com/docs/sortedcontainers/implementation.html
173181
.. _`Release History`: http://www.grantjenks.com/docs/sortedcontainers/history.html
174182

175183
API Documentation
176184
.................
177185

178-
If you are looking for information on a specific function, class or method,
179-
this part of the documentation is for you.
186+
The API documentation provides information on specific functions, classes, and
187+
modules in the `Sorted Containers`_ package.
180188

181189
- `Sorted List`_
182190
- `Sorted Dict`_
@@ -197,8 +205,8 @@ Talks
197205
.. _`SF Python Holiday Party 2015 Lightning Talk`: http://www.grantjenks.com/docs/sortedcontainers/sf-python-2015-lightning-talk.html
198206
.. _`DjangoCon 2015 Lightning Talk`: http://www.grantjenks.com/docs/sortedcontainers/djangocon-2015-lightning-talk.html
199207

200-
Useful Links
201-
------------
208+
Resources
209+
---------
202210

203211
- `Sorted Containers Documentation`_
204212
- `Sorted Containers at PyPI`_

docs/development.rst

Lines changed: 47 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,49 @@
1-
Developing and Contributing
2-
===========================
1+
Development and Support
2+
=======================
3+
4+
.. contents::
5+
:depth: 1
6+
:local:
7+
8+
Reporting Issues
9+
----------------
10+
11+
Support requests, bugs, issues, documentation typos, and general questions
12+
should be submitted via the `GitHub Issue Tracker`_. The issue tracker offers a
13+
web interface which allows relevant information to be entered and submitted to
14+
the :doc:`Sorted Containers<index>` developers. Steps to file an issue:
15+
16+
#. Please search the issues database to determine whether the problem has
17+
already been reported. It may be that a fix or workaround has already been
18+
provided or is soon to be released. If additional information is needed then
19+
you are welcome to reopen the issue and comment regarding your specific
20+
scenario.
21+
#. To file a new issue, click the green "New issue" button on the Issue
22+
Tracker. You will be required to sign-in to file an issue. It is not
23+
possible to submit an issue anonymously.
24+
#. The issue form has two primary fields: title and comment. The title should
25+
be a very short description of the problem; preferably less than ten words.
26+
The comment should describe the problem in detail, including what you
27+
expected to happen and what instead did happen. Working code samples that
28+
illustrate the issue are best.
29+
#. Submitted issues and comments will notify the lead developer and project
30+
maintainers. Bugs are typically fixed very quickly, within a week or so.
31+
Feature enhancements may take longer or be deferred until a pull request is
32+
made with a working prototype.
33+
34+
Support
35+
-------
36+
37+
Development of :doc:`Sorted Containers<index>` is lead by Grant Jenks
38+
<[email protected]>. The preferred method of contact for support is to
39+
create an issue on the `GitHub Issue Tracker`_. For anything sensitive, such as
40+
conduct issues or security issues, please contact the development lead directly
41+
by email.
42+
43+
.. _`GitHub Issue Tracker`: https://github.com/grantjenks/python-sortedcontainers/issues
44+
45+
How to Contribute?
46+
------------------
347

448
Collaborators are welcome!
549

@@ -8,16 +52,11 @@ Collaborators are welcome!
852
#. Fork the `repository`_ on GitHub and start making your changes to a new
953
branch.
1054
#. Write a test which shows that the bug was fixed.
11-
#. Send a pull request and bug the maintainer until it gets merged and
55+
#. Send a pull request and bug the development lead until it gets merged and
1256
published :)
1357

1458
.. _`repository`: https://github.com/grantjenks/python-sortedcontainers
1559

16-
Development Lead
17-
----------------
18-
19-
* Grant Jenks <[email protected]>
20-
2160
Requests for Contributions
2261
--------------------------
2362

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88
performance-load
99
performance-runtime
1010
performance-workload
11-
implementation
1211
performance-scale
1312
development
13+
implementation
1414
history
1515
sortedlist
1616
sorteddict

0 commit comments

Comments
 (0)