-
-
Notifications
You must be signed in to change notification settings - Fork 782
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add a 'plan for the contributor guide' page
- Loading branch information
Showing
3 changed files
with
57 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
.. _contrib-plan: | ||
|
||
================================ | ||
Plan for the Contributor's Guide | ||
================================ | ||
|
||
.. important:: | ||
|
||
|draft| | ||
|
||
|purpose| | ||
|
||
We are in the process of updating and refactoring the devguide to be a | ||
Contributor's Guide. It will highlight the different kinds of contribution | ||
possible, and how to succeed at each kind. | ||
|
||
Currently, the Contibutor's Guide is a draft in this new last section of the | ||
devguide. We welcome feedback, but please understand that some of the current | ||
content is moving or skeletal. | ||
|
||
Repo structure | ||
============== | ||
|
||
While the reorganization is happening, we are keeping the old devguide as it | ||
is. The new Contributor's Guide is represented in this last section, but will | ||
eventually be the only content in the guide. To avoid copying content, we're | ||
using Sphinx include directives to display existing devguide content in its new | ||
Contributor's Guide location. That is not how the eventual Guide will be | ||
built. Once we are ready to make the Contributor's Guide real, we will | ||
rearrange content into its new location. | ||
|
||
How to help | ||
=========== | ||
|
||
To help, you can: | ||
|
||
- `Write an issue`_ detailing a change you'd like to see here. | ||
- `Make a pull request`_ in this repo to add content. | ||
- Join us in the `Python Docs Discord`_ to collaborate with other docs-minded | ||
community members. | ||
- Get in touch with the `Docs Editorial Board`_ to discuss larger documentation | ||
concerns. | ||
|
||
.. _Write an issue: https://github.com/python/devguide/issues | ||
.. _Make a pull request: https://github.com/python/devguide/pulls | ||
.. _Python Docs Discord: https://discord.gg/NeGgyhUZ | ||
.. _Docs Editorial Board: https://python.github.io/editorial-board/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters