Move contributing under install sections
* pyglet on [PyPI]
* pyglet [discord] server
* pyglet [mailing list]
+* pyglet [issue tracker]
* Pyglet [website]
Pyglet has an active developer and user community. If you find a bug or issue, please [open an issue](https://github.com/pyglet/pyglet/issues).
@@ -54,20 +55,6 @@ pyglet is installable from PyPI:
pip install --upgrade pyglet --user
-## Contributing
-
-**A good way to start contributing to a component of pyglet is by its documentation**. When studying the code you are going to work with, also read the associated docs. If you don't understand the code with the help of the docs, it is a sign that the docs should be improved.
-
-If you want to contribute to Pyglet, we suggest the following:
-
-* Fork the [official repository](https://github.com/pyglet/pyglet/fork).
-* Apply your changes to your fork.
-* Submit a [pull request](https://github.com/pyglet/pyglet/pulls) describing the changes you have made.
-* Alternatively you can create a patch and submit it to the issue tracker.
-
-When making a pull request, check that you have addressed its respective documentation, both within the code docstrings and the programming guide (if applicable). It is very important to all of us that the documentation matches the latest code and vice-versa.
-
-Consequently, an error in the documentation, either because it is hard to understand or because it doesn't match the code, is a bug that deserves to be reported on a ticket.
## Installation from source
@@ -92,6 +79,21 @@ There are no compilation steps during the installation; if you prefer,
you can simply add this directory to your `PYTHONPATH` and use pyglet without
installing it. You can also copy pyglet directly into your project folder.
+## Contributing
+
+**A good way to start contributing to a component of pyglet is by its documentation**. When studying the code you are going to work with, also read the associated docs. If you don't understand the code with the help of the docs, it is a sign that the docs should be improved.
+
+If you want to contribute to Pyglet, we suggest the following:
+
+* Fork the [official repository](https://github.com/pyglet/pyglet/fork).
+* Apply your changes to your fork.
+* Submit a [pull request](https://github.com/pyglet/pyglet/pulls) describing the changes you have made.
+* Alternatively you can create a patch and submit it to the issue tracker.
+
+When making a pull request, check that you have addressed its respective documentation, both within the code docstrings and the programming guide (if applicable). It is very important to all of us that the documentation matches the latest code and vice-versa.
+
+Consequently, an error in the documentation, either because it is hard to understand or because it doesn't match the code, is a bug that deserves to be reported on a ticket.
+
## Building Docs
If you want to build the documentation yourself, please check
@@ -105,7 +107,7 @@ pyglet makes use of pytest for its test suite.
Please check the documentation for more information about running and writing tests.
-# Contact
+## Contact
pyglet is developed by many individual volunteers, and there is no central point of contact. If you have a question about developing with pyglet, or you wish to contribute, please join the [mailing list] or the [discord] channel.
@@ -117,3 +119,4 @@ For legal issues, please contact [Alex Holkner](mailto:Alex.Holkner@gmail.com).
[wiki]: https://github.com/pyglet/pyglet/wiki
[pypi]: https://pypi.org/project/pyglet/
[website]: http://pyglet.org/
+[issue tracker]: https://github.com/pyglet/pyglet/issues
