-
-
Notifications
You must be signed in to change notification settings - Fork 925
Add draft contributor's guide outline and pages #1388
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
Closed
Closed
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
9b33152
Add proposed outline for contrib.python.org guide
willingc fc3b228
Create contrib folder and index file
willingc 80810db
Add stub pages for guide
willingc 37e447d
add newline
willingc 191bc8b
add trailing newline for all stubs
willingc ac0096a
remove markdown file of outline
willingc ea51552
add discourse link to draft prolog
willingc adb60bc
Add link to EB as suggested by Guido
willingc File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
======== | ||
Outreach | ||
======== | ||
|
||
.. important:: | ||
|
||
|draft| | ||
|
||
|purpose| | ||
|
||
|
||
* Sprints |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.