Thanks to visit codestin.com
Credit goes to github.com

Skip to content

PyCon Sprint Guide #201

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
wants to merge 2 commits into from
Closed
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
5 changes: 5 additions & 0 deletions index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _index:

========================
Python Developer's Guide
========================
Expand Down Expand Up @@ -78,6 +80,7 @@ contributing to Python:
* PEPs_ (Python Enhancement Proposals)
* :doc:`gitdevs`
* :doc:`gitbootcamp`
* :doc:`sprintguide`

.. _branchstatus:

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -323,6 +327,7 @@ Full Table of Contents
gitdevs
motivations
gitbootcamp
sprintguide


.. _Buildbot status: https://www.python.org/dev/buildbot/
Expand Down
1 change: 1 addition & 0 deletions pullrequest.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
---------
Expand Down
143 changes: 143 additions & 0 deletions sprintguide.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
.. 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 <http://python.org/psf/codeofconduct/>`_.


.. 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 <index>` section of CPython Developer's Guide.

#. :ref:`Documenting Python <documenting>`.

#. :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 <licensing>`.

Communication
-------------

#. Core-mentorship `mailing list <https://mail.python.org/mailman/listinfo/core-mentorship/>`_.

#. Comment on the issue, say that you're working on it. If an issue is assigned,
please ask first.

#. #python-dev on `freenode <http://webchat.freenode.net/>`_.


Dev Guide Issues
Copy link
Member

Choose a reason for hiding this comment

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

We could have a shared Google Docs/ Spreadsheet / Label these issues with pyconsprint2017 (etc), instead of listing them in a PR. And we could mention that link here.

Because we will likely encounter more issues that will get added and we may not need a new PR to add an issue.

Copy link
Member Author

Choose a reason for hiding this comment

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

I wasn't sure myself where to list these issues, I realize the devguide may not be the best place.
But at least it becomes community-maintained.
Whereas if it's a google docs, someone has to take ownership of it.
My thinking is people should not add tickets randomly just because they think it's an easy ticket.
We should still vet each ticket to make sure that it is a legitimate issue that needs fixing/improvement. When it is listed in the devguide, it's a sign that it's been approved by a core developer.

Copy link
Member

Choose a reason for hiding this comment

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

In the past, we have had a shared document (similar to paste bin). That was the reason for my comment. And yes, usually a core dev takes an ownership to keep the doc updated. At the same other others can edit too. (If ownership is a problem, I can volunteer to be an owner of shared doc).

I am not -1, just sharing a point that it will be a cumbersome to keep list alive.

Copy link
Member

Choose a reason for hiding this comment

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

What if we enabled the wiki on this repo, and added this list as a page there?

Copy link
Member

Choose a reason for hiding this comment

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

That's a fantastic idea. I am +1 on that.

Copy link
Member Author

Choose a reason for hiding this comment

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

Sounds good.

I don't have access to add the wiki :)

Copy link
Member

Choose a reason for hiding this comment

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

@brettcannon, what say you?

Copy link
Member

Choose a reason for hiding this comment

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

@zware yep, add a wiki page instead of this PR, because a sprint code session can change from a pycon to an other one.

----------------

#. Document git worktree `python/devguide#105 <https://github.com/python/devguide/issues/105>`_.

#. Mention the "Green Tree Snakes" AST guide `python/devguide#184 <https://github.com/python/devguide/issues/184>`_.

#. Clarify policy of personal branches `python/devguide#191 <https://github.com/python/devguide/issues/191>`_.

#. Document how to apply mercurial patch to git `python/devguide#193 <https://github.com/python/devguide/issues/193>`_.

#. Promote helping with reviews `python/devguide#194 <https://github.com/python/devguide/issues/194>`_.

#. Improve commit message `python/devguide#199 <https://github.com/python/devguide/issues/199>`_.

#. Mention the core-workflow mailing list / repo `python/devguide#202 <https://github.com/python/devguide/issues/202>`_.


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 <https://bugs.python.org/issue30361>`_.

#. Small correction in set code sample `bpo-30312 <https://bugs.python.org/issue30312>`_.

#. sum() function docstring lists arguments incorrectly `bpo-23787 <https://bugs.python.org/issue23787>`_.

#. asyncio: set_write_buffer_limits() doc doesn't specify unit of the parameters `bpo-29933 <https://bugs.python.org/issue29933>`_.

#. socket module missing IPPROTO_IPV6, IPPROTO_IPV4 on Windows `bpo-29515 <https://bugs.python.org/issue29515>`_.

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 <https://bugs.python.org/issue30050>`_.

#. Modernize pydoc to use better HTML and separate CSS `bpo-10716 <http://bugs.python.org/issue10716>`_.

#. Command-line option to suppress "from None" for debugging `bpo-30097 <http://bugs.python.org/issue30097>`_.


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 <https://bugs.python.org/issue30145>`_) or typing.

#. Research and design a replacement for ``pprint``.

#. Convert text based PEPs to reST `python/peps#4 <https://github.com/python/peps/issues/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.