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: populate the Code section #1450

Merged
merged 2 commits into from
Oct 19, 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
25 changes: 25 additions & 0 deletions contrib/code/developer-workflow.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
====================
Development workflow
====================

.. important::

|draft|

|purpose|

[This is the existing :ref:`dev-workflow` page from the devguide]

.. toctree::
:maxdepth: 5

../../developer-workflow/communication-channels
../../developer-workflow/development-cycle
../../developer-workflow/stdlib
../../developer-workflow/extension-modules
../../developer-workflow/c-api
../../developer-workflow/lang-changes
../../developer-workflow/grammar
../../developer-workflow/porting
../../developer-workflow/sbom
../../developer-workflow/psrt
19 changes: 19 additions & 0 deletions contrib/code/development-tools.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
=================
Development tools
=================

.. important::

|draft|

|purpose|

[This is the existing :ref:`development-tools` page from the devguide.]

.. toctree::
:maxdepth: 5

../../development-tools/clinic
../../development-tools/gdb
../../development-tools/clang
../../development-tools/warnings
11 changes: 11 additions & 0 deletions contrib/code/git.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
========
Git tips
========

.. important::

|draft|

|purpose|

[More git help for advanced things needed by code contributors.]
25 changes: 17 additions & 8 deletions contrib/code/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,20 @@ Code contributions

|purpose|

* Code setup and building (more complex stuff, delta from basic setup above)
* More Git bootcamp (pull requests, 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
[The main page for code contributors.]

[We'll include code-focused content from the :ref:`main devguide page <devguide-main>`: Quick
reference, Quick links, Proposing changes, and so on.]

[The existing "CPython's internals" section of the devguide will be fully
migrated into the Python repo.]


.. toctree::
:maxdepth: 5

setup
git
developer-workflow
testing
development-tools
12 changes: 12 additions & 0 deletions contrib/code/setup.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
==================
Setup and building
==================

.. important::

|draft|

|purpose|

[More setup and build instructions specifically for code contributors, building
on the basics from the :ref:`Getting Started <getting-started>` section.]
20 changes: 20 additions & 0 deletions contrib/code/testing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
=====================
Testing and buildbots
=====================

.. important::

|draft|

|purpose|

[This is the existing :ref:`testing` page from the devguide.]

.. toctree::
:maxdepth: 5

../../testing/run-write-tests
../../testing/silence-warnings
../../testing/coverage
../../testing/buildbots
../../testing/new-buildbot-worker
2 changes: 2 additions & 0 deletions developer-workflow/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _dev-workflow:

====================
Development workflow
====================
Expand Down
2 changes: 2 additions & 0 deletions development-tools/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _development-tools:

=================
Development tools
=================
Expand Down
2 changes: 2 additions & 0 deletions getting-started/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _getting-started:

===============
Getting started
===============
Expand Down
2 changes: 2 additions & 0 deletions index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _devguide-main:

========================
Python Developer's Guide
========================
Expand Down
2 changes: 2 additions & 0 deletions testing/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _testing:

=====================
Testing and buildbots
=====================
Expand Down
Loading