Skip to content

Commit

Permalink
remove the outline since it's now being fleshed out
Browse files Browse the repository at this point in the history
  • Loading branch information
nedbat committed Oct 12, 2024
1 parent 459509e commit 4780213
Showing 1 changed file with 4 additions and 71 deletions.
75 changes: 4 additions & 71 deletions contrib/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ Python Contributor's Guide (draft)

This guide is a comprehensive resource for contributing to Python.

.. note::
This is a draft of a new organization for the devguide, turning it into a
Contributor's Guide.

.. toctree::
:maxdepth: 2

Expand All @@ -23,74 +27,3 @@ This guide is a comprehensive resource for contributing to Python.
user-success
security
outreach


.. _proposed_contents:

Proposed Contents
-----------------

We are in the process of restructuring the classic "devguide" into a broader
Contribution Guide. It's being fleshed out above. This is the original
proposed outline for reference:

* 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 team (from devguide)
* Triager
* Contributors
* types of contributions
* Governance
* (SC?) (EB?)
* Other WG? Typing council? C-API WG?
* GitHub
* Main CPython repos
* 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?
* 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

0 comments on commit 4780213

Please sign in to comment.