diff --git a/conf.py b/conf.py index fc46f32234..21e7e9901b 100644 --- a/conf.py +++ b/conf.py @@ -166,6 +166,12 @@ # sphinx-notfound-page notfound_urls_prefix = "/" +# prolog and epilogs +rst_prolog = """ +.. |draft| replace:: **Draft** of Python Contributor's Guide +.. |purpose| replace:: See more info about the contributor guide at https://discuss.python.org/t/refactoring-the-devguide-into-a-contribution-guide/63409. Questions? Ask the docs editorial board (https://python.github.io/editorial-board/). +""" + # sphinx.ext.extlinks # This config is a dictionary of external sites, # mapping unique short aliases to a base URL and a prefix. diff --git a/contrib/code.rst b/contrib/code.rst new file mode 100644 index 0000000000..6c23c3a87a --- /dev/null +++ b/contrib/code.rst @@ -0,0 +1,18 @@ +================== +Code contributions +================== + +.. important:: + + |draft| + + |purpose| + +* Code setup and building (more complex stuff, delta from basic setup above) +* More git bootcamp (patches, etc) +* Lifecycle of a code pull request +* Development workflow (from devguide) +* Testing and buildbots (from devguide) +* Development tools (from devguide) +* CPython’s internals (from devguide) +* Code style guide diff --git a/contrib/doc.rst b/contrib/doc.rst new file mode 100644 index 0000000000..133719d6e2 --- /dev/null +++ b/contrib/doc.rst @@ -0,0 +1,15 @@ +=========================== +Documentation contributions +=========================== + +.. important:: + + |draft| + + |purpose| + + +* Lifecycle of a docs pull request +* (pull in Documentation sections from devguide) +* Rst/Sphinx bootcamp +* Editorial Style Guide diff --git a/contrib/get-started.rst b/contrib/get-started.rst new file mode 100644 index 0000000000..84c5afd707 --- /dev/null +++ b/contrib/get-started.rst @@ -0,0 +1,13 @@ +=============== +Getting started +=============== + +.. important:: + + |draft| + + |purpose| + + +* Basic setup +* Git bootcamp (simplified for everyone to use) diff --git a/contrib/index.rst b/contrib/index.rst new file mode 100644 index 0000000000..455891b7c0 --- /dev/null +++ b/contrib/index.rst @@ -0,0 +1,94 @@ +================================== +Python Contributor's Guide (draft) +================================== + +.. important:: + + |draft| + + |purpose| + + +This guide is a comprehensive resource for contributing to Python. + +.. toctree:: + :maxdepth: 2 + + intro + project + get-started + code + doc + translation + user-success + security + outreach + + +.. _proposed_contents: + +Proposed Contents +----------------- + +* Introduction + * Importance of healthy inclusive collaboration (While code is a large part of the project's success, project management, documentation, governance, sprint outreach, etc. matter). We respect the individual skills people bring to the project and strive to create and maintain a culture of inclusion. + * About this guide + * Types of contribution (Pathways for Contributors) + * Helping with the Contributors' Guide +* The CPython project + * Structure + * CoC + * Standard for communication + * Enforcement details + * Roles + * Core teamdevelopers (from devguide) + * (SC?) (EB?) + * Triager + * Contributors + * types of contributions, role of each contributors + * Governance + * (SC?) (EB?) + * Other WG? Typing council? C-API WG? + * GitHub + * Main CPython rRepos + * Core workflow repos + * Infrastructure repos + * Communication channels + * Repos + * Discourse + * Discord + * Mailing lists (deprioritize) + * Where to get help + * Issue triaging + * (How exactly? Guidelines? Is it just about applying labels?) + * Easy issues + * (should triagers assign reviewers?) + * (should triagers close issues?) + * (Reviewing) + * How? Etiquette? + * How to request a review? + * Where to get help +* Getting started + * Basic setup + * Git bootcamp (simplified for everyone to use) +* Code contributions + * Code setup and building (more complex stuff, delta from basic setup above) + * More git bootcamp (patches, etc) + * Lifecycle of a code pull request + * Development workflow (from devguide) + * Testing and buildbots (from devguide) + * Development tools (from devguide) + * CPython’s internals (from devguide) + * Code style guide +* Documentation contributions + * Lifecycle of a docs pull request + * (pull in Documentation sections from devguide) + * Rst/Sphinx bootcamp + * Editorial Style Guide +* Translation + * Need details +* Accessibility and user success +* Security and infrastructure + * Core Team Resources (from the devguide +* Outreach + * Sprints diff --git a/contrib/intro.rst b/contrib/intro.rst new file mode 100644 index 0000000000..f0953ebbee --- /dev/null +++ b/contrib/intro.rst @@ -0,0 +1,15 @@ +============ +Introduction +============ + +.. important:: + + |draft| + + |purpose| + + +* Importance of healthy inclusive collaboration (While code is a large part of the project's success, project management, documentation, governance, sprint outreach, etc. matter). We respect the individual skills people bring to the project and strive to create and maintain a culture of inclusion. +* About this guide +* Types of contribution (Pathways for Contributors) +* Helping with the Contributors' Guide diff --git a/contrib/outreach.rst b/contrib/outreach.rst new file mode 100644 index 0000000000..d43aa8e9de --- /dev/null +++ b/contrib/outreach.rst @@ -0,0 +1,12 @@ +======== +Outreach +======== + +.. important:: + + |draft| + + |purpose| + + +* Sprints diff --git a/contrib/project.rst b/contrib/project.rst new file mode 100644 index 0000000000..09f545a353 --- /dev/null +++ b/contrib/project.rst @@ -0,0 +1,43 @@ +=================== +The CPython project +=================== + +.. important:: + + |draft| + + |purpose| + + +* Structure +* CoC + * Standard for communication + * Enforcement details +* Roles + * Core teamdevelopers (from devguide) + * (SC?) (EB?) + * Triager + * Contributors + * types of contributions, role of each contributors +* Governance + * (SC?) (EB?) + * Other WG? Typing council? C-API WG? +* GitHub + * Main CPython rRepos + * Core workflow repos + * Infrastructure repos +* Communication channels + * Repos + * Discourse + * Discord + * Mailing lists (deprioritize) + * Where to get help +* Issue triaging + * (How exactly? Guidelines? Is it just about applying labels?) + * Easy issues + * (should triagers assign reviewers?) + * (should triagers close issues?) +* (Reviewing) + * How? Etiquette? + * How to request a review? +* Where to get help diff --git a/contrib/security.rst b/contrib/security.rst new file mode 100644 index 0000000000..db40b4a167 --- /dev/null +++ b/contrib/security.rst @@ -0,0 +1,13 @@ +========================================= +Security and infrastructure contributions +========================================= + +.. important:: + + |draft| + + |purpose| + +* Security +* Infrastructure +* Core workflow diff --git a/contrib/translation.rst b/contrib/translation.rst new file mode 100644 index 0000000000..b337fb6ff6 --- /dev/null +++ b/contrib/translation.rst @@ -0,0 +1,12 @@ +=========== +Translation +=========== + +.. important:: + + |draft| + + |purpose| + +* How to add a new language +* Tools and workflow diff --git a/contrib/user-success.rst b/contrib/user-success.rst new file mode 100644 index 0000000000..2a9ef5d4e5 --- /dev/null +++ b/contrib/user-success.rst @@ -0,0 +1,14 @@ +======================================= +Accessibility, design, and user success +======================================= + +.. important:: + + |draft| + + |purpose| + + +* Accessibility +* Design +* User success diff --git a/index.rst b/index.rst index b385b1ee1b..c10736a474 100644 --- a/index.rst +++ b/index.rst @@ -315,6 +315,7 @@ Full table of contents core-developers/index internals/index versions + contrib/index .. _Buildbot status: https://www.python.org/dev/buildbot/ .. _Misc directory: https://github.com/python/cpython/tree/main/Misc