From 770f191b47dfa09e9695757d7d53519af7d7b7a5 Mon Sep 17 00:00:00 2001 From: Mariatta Wijaya Date: Thu, 18 May 2017 08:34:38 -0700 Subject: [PATCH 1/2] PyCon Sprint Guide Provide several easy issues for first time contributors Provide ideas for other long term contributions Somewhat related to https://github.com/python/devguide/issues/7 --- index.rst | 5 ++ pullrequest.rst | 1 + sprintguide.rst | 141 ++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 147 insertions(+) create mode 100644 sprintguide.rst diff --git a/index.rst b/index.rst index e1338050e1..87343849e9 100644 --- a/index.rst +++ b/index.rst @@ -1,3 +1,5 @@ +.. _index: + ======================== Python Developer's Guide ======================== @@ -78,6 +80,7 @@ contributing to Python: * PEPs_ (Python Enhancement Proposals) * :doc:`gitdevs` * :doc:`gitbootcamp` +* :doc:`sprintguide` .. _branchstatus: @@ -182,6 +185,7 @@ Guide for contributing to Python: * :doc:`coverity` * :doc:`gitdevs` * :doc:`gitbootcamp` +* :doc:`sprintguide` It is **recommended** that the above documents be read in the order listed. You can stop where you feel comfortable and begin contributing immediately without @@ -323,6 +327,7 @@ Full Table of Contents gitdevs motivations gitbootcamp + sprintguide .. _Buildbot status: https://www.python.org/dev/buildbot/ diff --git a/pullrequest.rst b/pullrequest.rst index 0289970bf7..04102db49e 100644 --- a/pullrequest.rst +++ b/pullrequest.rst @@ -176,6 +176,7 @@ Make a pull request on GitHub from your changes in ``MY_BRANCH_NAME``. You can still upload a patch to bugs.python.org_, but the GitHub pull request workflow is **strongly** preferred. +.. _licensing: Licensing --------- diff --git a/sprintguide.rst b/sprintguide.rst new file mode 100644 index 0000000000..d5c81bda70 --- /dev/null +++ b/sprintguide.rst @@ -0,0 +1,141 @@ +.. highlight:: console + +.. _sprintguide: + +PyCon Sprint Guide +================== + +This guide is written for PyCon US 2017 sprint. For other sprints, we may need +to come up with a different set of easy b.p.o. issues. + +Everyone at the sprint needs to follow the `PSF Code of Conduct `_. + + +.. contents:: + +Installations +------------- + +The following resources take time to download. You may not want to rely on the +on the conference venue's wifi to download these. Do them before you come to +the sprint. + +#. Go through the :ref:`setup` guide. Install the necessary dependencies + for your machine. + +#. Install sphinx v1.6.1:: + + pip install sphinx~=1.6.1 + +#. Fork and clone the CPython repo. Set your clone as the ``origin``, and + ``https://github.com/python/cpython`` as ``upstream``. + +#. Fork and clone the Dev Guide repo. Set your clone as the ``origin``, and + ``https://github.com/python/devguide`` as ``upstream``. + +Reading materials +----------------- + +#. :ref:`Quick Start ` section of CPython Developer's Guide. + +#. :ref:`Documenting Python `. + +#. :ref:`gitbootcamp`. + +#. :ref:`exploring`. + +#. :ref:`helptriage`. + +Others +------ + +#. The bug tracker is at: https://bugs.python.org + +#. Create an account at the bug tracker. + +#. Link your GitHub account to the bug tracker account. + +#. Sign the :ref:`CLA `. + +Communication +------------- + +#. Core-mentorship `mailing list `_. + +#. Comment on the issue, say that you're working on it. If an issue is assigned, + please ask first. + +#. #python-dev on `freenode `_. + + +Dev Guide Issues +---------------- + +#. Document git worktree `python/devguide#105 `_. + +#. Mention the "Green Tree Snakes" AST guide `python/devguide#184 `_. + +#. Clarify policy of personal branches `python/devguide#191 `_. + +#. Document how to apply mercurial patch to git `python/devguide#193 `_. + +#. Promote helping with reviews `python/devguide#194 `_. + +#. Improve commit message `python/devguide#199 `_. + + +Easy B.P.O Issues +----------------- + +These issues have been set aside for first time contributors only. If you've +contributed before, you'll find other issues to be more challenging. + +#. Docs example: converting mixed types to floating point `bpo-30361 `_. + +#. Small correction in set code sample `bpo-30312 `_. + +#. sum() function docstring lists arguments incorrectly `bpo-23787 `_. + +#. asyncio: set_write_buffer_limits() doc doesn't specify unit of the parameters `bpo-29933 `_. + +#. socket module missing IPPROTO_IPV6, IPPROTO_IPV4 on Windows `bpo-29515 `_. + +Other B.P.O Issues +------------------ + +These issues are more complicated and require some API design. + +#. Please provide a way to disable the warning printed if the signal module's wakeup fd overflows `bpo-30050 `_. + +#. Modernize pydoc to use better HTML and separate CSS `bpo-10716 `_. + +#. Command-line option to suppress "from None" for debugging `bpo-30097 `_. + + +Other Long Term Project Ideas +----------------------------- + +#. Help port your favorite python library from 2 to 3. + +#. The newer features of the language could use more help in documentation. + For example, write a howto/tutorial for asyncio (`bpo-30145 `_) or typing. + +#. Research and design a replacement for ``pprint``. + +#. Convert text based PEPs to reST `python/peps#4 `_ + + +Other Ways to Contribute +------------------------ + +There are various ways to contribute to open source projects and to Python. It +doesn't always invlove writing code and submitting patches. + +#. Help review open pull requests. + +#. Apply and test patches on your machine. + +#. Issue triage. + +#. Be positive. + From 049e464db1a03544c652e5512d65e7f2b13cae59 Mon Sep 17 00:00:00 2001 From: Mariatta Wijaya Date: Thu, 18 May 2017 09:10:00 -0700 Subject: [PATCH 2/2] add devguide issue #202 --- sprintguide.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/sprintguide.rst b/sprintguide.rst index d5c81bda70..b49a043877 100644 --- a/sprintguide.rst +++ b/sprintguide.rst @@ -83,6 +83,8 @@ Dev Guide Issues #. Improve commit message `python/devguide#199 `_. +#. Mention the core-workflow mailing list / repo `python/devguide#202 `_. + Easy B.P.O Issues -----------------