Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Contrib guide: more restructuring #1461

Merged
merged 3 commits into from
Nov 3, 2024
Merged
Show file tree
Hide file tree
Changes from all 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 _static/devguide_overrides.css
Original file line number Diff line number Diff line change
Expand Up @@ -94,3 +94,9 @@
font-size: var(--font-size--small--2);
padding: .1em .2em;
}

/* Table cells should always top-align */

table.docutils td {
vertical-align: top;
}
2 changes: 2 additions & 0 deletions contrib/code/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _c_code:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This made me think of C the language.

Are these c_ prefixes short for "contrib" and temporary whilst still a draft in parallel with the old devguide?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, exactly. I maybe should have explained that.


==================
Code contributions
==================
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@
[This is the existing core developers :ref:`committing` page from the devguide. We'll
adjust "core developer" to "core team" where appropriate.]

.. include:: ../../../core-developers/committing.rst
.. include:: ../../core-developers/committing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@
[This is the existing core developers :ref:`developer-log` page from the devguide. We'll
adjust "core developer" to "core team" where appropriate.]

.. include:: ../../../core-developers/developer-log.rst
.. include:: ../../core-developers/developer-log.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@
[This is the existing core developers :ref:`experts` page from the devguide. We'll
adjust "core developer" to "core team" where appropriate.]

.. include:: ../../../core-developers/experts.rst
.. include:: ../../core-developers/experts.rst
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ adjust "core developer" to "core team" where appropriate.]
How to join the core team
=========================

.. include:: ../../../core-developers/become-core-developer.rst
.. include:: ../../core-developers/become-core-developer.rst
:start-line: 7
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@
[This is the existing core developers :ref:`motivations` page from the devguide. We'll
adjust "core developer" to "core team" where appropriate.]

.. include:: ../../../core-developers/motivations.rst
.. include:: ../../core-developers/motivations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@
[This is the existing core developers :ref:`responsibilities` page from the devguide. We'll
adjust "core developer" to "core team" where appropriate.]

.. include:: ../../../core-developers/responsibilities.rst
.. include:: ../../core-developers/responsibilities.rst
2 changes: 2 additions & 0 deletions contrib/doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _c_docs:

===========================
Documentation contributions
===========================
Expand Down
2 changes: 2 additions & 0 deletions contrib/get-started/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _c_gettingstarted:

===============
Getting started
===============
Expand Down
100 changes: 90 additions & 10 deletions contrib/index.rst
Original file line number Diff line number Diff line change
@@ -1,28 +1,104 @@
.. _c_root:

==================================
Python Contributor's Guide (draft)
==================================

.. raw:: html

<script>
document.addEventListener('DOMContentLoaded', function() {
activateTab(getOS());
});
</script>


.. important::

|draft|

|purpose|


This guide is a comprehensive resource for contributing to Python.
[Open question: how to divide content between this Introduction and the
:ref:`introduction <c_intro>`?]

This guide is a comprehensive resource for :ref:`contributing <contributing>`
to Python_ -- for both new and experienced contributors. It is :ref:`maintained
<devguide>` by the same community that maintains Python. We welcome your
contributions to Python!

We encourage everyone to contribute to Python. This guide should have
everything you need to get started and be productive. If you still have
questions after reviewing the material in this guide, the `Core Python
Mentorship`_ group is available to help you through the process.

There are a number of ways to contribute including code, documentation, and
triaging issues. We've organized this guide to provide specifics based on the
type of activity you'll be engaged in.


Using this guide
================

.. note::
This is a draft of a new organization for the devguide, turning it into a
Contributor's Guide.
We recommend reading this guide as needed. You can stop where you feel
comfortable and begin contributing immediately without reading and
understanding everything. If you do choose to skip around this guide, be aware
that it is written assuming preceding sections have been read so you may need
to backtrack to fill in missing concepts and terminology.

[Much of the devguide home page will be here. The Quick Start will be updated
to distinguish code vs documentation contributions, and moved to those
sections. Other changes will be made to explain the different types of
contribution and how to navigate the guide for your own type.]
No matter what kind of contribution you'll be making, you should start with
these common sections:

* :ref:`c_intro`
* :ref:`c_project`
* :ref:`c_gettingstarted`

Then choose a path based on your type of activity:

*[The original table on the devguide home had a fourth column for Core
Developers. That made the table wider and more confusing. I don't think core
team members need a quick intro path since they will have been through the
devguide before.]*

*[I haven't adjusted the links in the table yet other than to add a link to the
major section at the top of each column.]*

.. list-table::
Copy link
Member

@hugovk hugovk Oct 31, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm trying to think which is better, lists inside a table, or smaller cells, from an accessibility point of view, and I'm not sure :)

The new table of lists might be better, because there's no relation between the old cells that happen to be next to each other; that is, the old way was just for presentation and not structure. So I think the list might be better?

image

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other people I've talked with definitely felt like the one-link-per-cell style of the current home page table is misleading because the rows have no meaning.

:widths: 10 10 10
:header-rows: 1

* - :ref:`Triaging <c_triage>`
- :ref:`Documentation <c_docs>`
- :ref:`Code <c_code>`
* -
* :ref:`tracker`
* :ref:`triaging`
* :ref:`helptriage`
* :ref:`experts`
* :ref:`labels`
* :ref:`gh-faq`
* :ref:`triage-team`
-
* :ref:`docquality`
* :ref:`documenting`
* :ref:`style-guide`
* :ref:`rst-primer`
* :ref:`translating`
* :ref:`devguide`
-
* :ref:`setup`
* :ref:`help`
* :ref:`pullrequest`
* :ref:`runtests`
* :ref:`fixingissues`
* :ref:`communication`
* :ref:`gitbootcamp`
* :ref:`devcycle`


.. toctree::
:maxdepth: 2
:maxdepth: 3

contrib-plan
intro/index
Expand All @@ -31,6 +107,10 @@ contribution and how to navigate the guide for your own type.]
triage/index
code/index
doc/index
core-team/index
user-success
security
outreach


.. _Python: https://www.python.org/
.. _Core Python Mentorship: https://www.python.org/dev/core-mentorship/
27 changes: 23 additions & 4 deletions contrib/intro/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _c_intro:

============
Introduction
============
Expand All @@ -10,10 +12,27 @@ Introduction



[Open question: how to divide content between this Introduction and the
:ref:`home page <c_root>`?]

Welcome!

Healthy Collaboration
New to open source?
===================

Python is an open source project, with culture and techniques from the broader
open source world. You might find it helpful to read about open source in
general. A number of individuals from the Python community have contributed to
a series of excellent guides at `Open Source Guides
<https://opensource.guide/>`_.

Anyone will find the following guides useful:

* `How to Contribute to Open Source <https://opensource.guide/how-to-contribute/>`_
* `Building Welcoming Communities <https://opensource.guide/building-community/>`_


Healthy collaboration
=====================

[Importance of healthy inclusive collaboration]
Expand All @@ -22,13 +41,13 @@ Healthy Collaboration

[We respect the individual skills people bring to the project and strive to create and maintain a culture of inclusion.]

About this Guide
About this guide
================

Types of Contribution
Types of contribution
=====================

[Pathways for contributors]

Helping with this Guide
Helping with this guide
=======================
10 changes: 10 additions & 0 deletions contrib/project/generative-ai.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. important::

|draft|

|purpose|


[This is the existing :ref:`generative-ai` page from the devguide.]

.. include:: ../../getting-started/generative-ai.rst
5 changes: 4 additions & 1 deletion contrib/project/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _c_project:

===================
The CPython project
===================
Expand All @@ -19,7 +21,8 @@ moving parts, who is involved, how do they interact?]

conduct
roles
core-team/index
governance
generative-ai.rst
github
channels
outreach
File renamed without changes.
2 changes: 2 additions & 0 deletions contrib/triage/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _c_triage:

===================
Issues and triaging
===================
Expand Down
Loading