Skip to content
Closed
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
"""

# sphinx.ext.extlinks
# This config is a dictionary of external sites,
# mapping unique short aliases to a base URL and a prefix.
Expand Down
18 changes: 18 additions & 0 deletions contrib/code.rst
Original file line number Diff line number Diff line change
@@ -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
15 changes: 15 additions & 0 deletions contrib/doc.rst
Original file line number Diff line number Diff line change
@@ -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
13 changes: 13 additions & 0 deletions contrib/get-started.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
===============
Getting started
===============

.. important::

|draft|

|purpose|


* Basic setup
* Git bootcamp (simplified for everyone to use)
94 changes: 94 additions & 0 deletions contrib/index.rst
Original file line number Diff line number Diff line change
@@ -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
15 changes: 15 additions & 0 deletions contrib/intro.rst
Original file line number Diff line number Diff line change
@@ -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
12 changes: 12 additions & 0 deletions contrib/outreach.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
========
Outreach
========

.. important::

|draft|

|purpose|


* Sprints
43 changes: 43 additions & 0 deletions contrib/project.rst
Original file line number Diff line number Diff line change
@@ -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
13 changes: 13 additions & 0 deletions contrib/security.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
=========================================
Security and infrastructure contributions
=========================================

.. important::

|draft|

|purpose|

* Security
* Infrastructure
* Core workflow
12 changes: 12 additions & 0 deletions contrib/translation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
===========
Translation
===========

.. important::

|draft|

|purpose|

* How to add a new language
* Tools and workflow
14 changes: 14 additions & 0 deletions contrib/user-success.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
=======================================
Accessibility, design, and user success
=======================================

.. important::

|draft|

|purpose|


* Accessibility
* Design
* User success
1 change: 1 addition & 0 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading