Skip to content

Commit a3deb77

Browse files
jeff5jeff5
authored
Adjust basic pages to use of GitHub (GH-8)
Remove (or demote) references to Mercurial. Some further Jythonisation of the commands and links, assumes future repo at jython/jython. Update to release process notes using GitHub.
1 parent afbea48 commit a3deb77

File tree

5 files changed

+216
-251
lines changed

5 files changed

+216
-251
lines changed

‎help.rst‎

Lines changed: 6 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -16,35 +16,22 @@ usage then please check the rest of this guide first as it should answer your
1616
question.
1717

1818

19-
Ask #jython
20-
-----------
21-
22-
If you are comfortable with IRC you can try asking on ``#jython`` (on
23-
the `freenode`_ network). Often there are experienced developers around,
24-
ranging from triagers to core developers, who can answer questions about
25-
developing for Jython, although it helps to be patient as it sometimes
26-
takes a little while for a question to get noticed.
27-
28-
.. _freenode: http://freenode.net/
29-
30-
3119
Core Mentorship
3220
---------------
3321

3422
If you are interested in improving Jython and contributing to its development,
3523
but don’t yet feel entirely comfortable with the public channels mentioned
36-
above, `Python Mentors`_ are here to help you. The Python Mentors list was
37-
originally created to help with CPython development, but since Jython shares
38-
most of the same infrastructure (Jython's repository is at hg.python.org
39-
and uses a related Roundup issue tracker) it is a good place to find help for
24+
above, `Python Mentors`_ may be there to help you. The Python Mentors list was
25+
originally created to help with CPython development, but since Jython an
26+
implementation acknowledgef by the PSF, it may be a good place to find help for
4027
Jython as well. Python is fortunate to have a community of volunteer core
4128
developers willing to mentor anyone wishing to contribute code, work on bug
4229
fixes or improve documentation. Everyone is welcomed and encouraged to
4330
contribute.
4431

4532
.. _Python Mentors: http://pythonmentors.com
4633

47-
.. FIXME: would Python Mentors count themselves a good place to go fro Jython?
34+
.. FIXME: would Python Mentors count themselves a good place to go for Jython?
4835
4936
Mailing Lists
5037
-------------
@@ -63,11 +50,12 @@ File a Bug
6350

6451
If you strongly suspect you have stumbled on a bug (be it in the build
6552
process, in the test suite, or in other areas), then open an issue on the
66-
`Jython issue tracker`_. As with every bug report it is strongly advised that
53+
`Jython GitHub repository`_. As with every bug report it is strongly advised that
6754
you detail which conditions triggered it (including the OS name and version,
6855
which JVM and version, and what you were trying to do), as well as the exact
6956
error message you encountered.
7057

58+
.. _Jython GitHub repository: https://github.com/jython/jython
7159
.. _Jython issue tracker: http://bugs.jython.org
7260

7361
.. _jython-users: https://lists.sourceforge.net/lists/listinfo/jython-users

‎index.rst‎

Lines changed: 57 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,24 @@
22
Normally this would mean a new file index_jy.rst, but index.rst is the
33
starting point for the documentation.
44
We therefore keep it as modified, although merging changes from the CPython
5-
devguide difficult for this file.
5+
devguide will be difficult for this file.
66
77
========================
88
Jython Developer's Guide
99
========================
1010

1111
This guide is a comprehensive resource for :ref:`contributing <contributing>`
1212
to Jython_ -- for both new and experienced contributors.
13-
It has been adapted from the CPython Developer's Guide and the reader should
13+
It has been (somewhat incompletely)
14+
adapted from the CPython Developer's Guide and the reader should
1415
bear in mind that:
1516

16-
* The CPython process is PR-based on GitHub and this guide anticipates our
17-
adoption of that for Jython.
18-
* The existing Jython process uses Mercurial so the guide describes that too.
17+
* The Jython process, like CPython's, is based GitHub PRs,
18+
but Jython does not have the same set of tool integrations.
19+
* Jython migrated from Mercurial in 2020, much later than CPython,
20+
so Jython-specific parts of the guide may refer to the old process.
1921
* Statements about "Python" should apply to both CPython and Jython.
20-
* The adaptation is imperfect: parts of the guide will say (or mean) CPython.
22+
The adaptation is imperfect: parts of the guide will say (or mean) CPython.
2123

2224
This guide is :ref:`maintained <helping-with-the-developers-guide>` by the same
2325
community that maintains CPython and Jython.
@@ -30,20 +32,9 @@ Quick Reference
3032
Mercurial
3133
^^^^^^^^^
3234

33-
1. :ref:`Get the source code <checkout-jy>`::
35+
Mercurial is no longer used.
36+
The previous official repository at ``https://hg.python.org/jython`` is not current.
3437

35-
hg clone http://hg.python.org/jython
36-
37-
2. :ref:`Build Jython <compiling-jy>`::
38-
39-
ant
40-
41-
3. :doc:`Run the tests <runtests_jy>`::
42-
43-
ant regrtest
44-
45-
4. Make the :doc:`patch <patch_hg_jy>`.
46-
5. Submit it to the `Jython issue tracker`_.
4738

4839
GitHub
4940
^^^^^^
@@ -56,7 +47,7 @@ instructions please see the :ref:`setup guide <setup-jy>`.
5647
1. Install and set up :ref:`Git <vcsetup-jy>` and other dependencies
5748
(see the :ref:`Get Setup <setup-jy>` page for detailed information).
5849

59-
2. Fork `the Jython repository <https://github.com/jython/jython>`_
50+
2. Fork the `Jython GitHub repository`_
6051
to your GitHub account and :ref:`get the source code <checkout-jy>` using::
6152

6253
git clone https://github.com/<your_username>/jython
@@ -72,39 +63,50 @@ instructions please see the :ref:`setup guide <setup-jy>`.
7263

7364
4. :doc:`Run the tests <runtests_jy>`::
7465

75-
dist/bin/jython -m test -e
66+
dist/bin/jython -m test.regrtest -e
7667

77-
(for Jython 3). With Jython 2.7, replace ``test`` with ``test.regrtest``.
68+
This applies for Jython 2.7.
69+
To test Jython 3, when it exists, replace ``test.regrtest`` with ``test``.
7870

7971
5. Create a new branch where your work for the issue will go, e.g.::
8072

8173
git checkout -b fix-issue-12345 master
8274

83-
If an issue does not already exist, please `create it
84-
<https://bugs.jython.org/>`_. Trivial issues (e.g. typo fixes) do not
85-
require any issue to be created.
75+
If an issue does not already exist, please create it on
76+
the `Jython GitHub repository`_.
77+
The legacy `bug tracker <https://bugs.jython.org/>`_ still operates
78+
(for Jython 2.7 only) but is not preferred.
79+
Trivial issues (e.g. typo fixes) do not require any issue to be created:
80+
create a PR directly.
8681

8782
6. Once you fixed the issue, run the tests, and if
8883
everything is ok, commit.
8984

90-
7. Push the branch on your fork on GitHub and :doc:`create a pull request
91-
<pullrequest>`. Include the issue number using ``bpo-NNNN`` in the
92-
pull request description. For example::
85+
7. Push the branch to your fork on GitHub::
86+
87+
git push -u origin fix-issue-12345
9388

94-
bpo-12345: Fix some bug in spam module
89+
and :doc:`create a pull request
90+
<pullrequest>`.
91+
Include the issue number using GitHub conventions in the pull request
92+
description.
93+
(Use ``bjo-NNNN`` if it is from the legacy tracker.)
9594

9695
.. note::
9796

98-
bpo stands for bugs.python.org and these flags are used by CPython's GitHub
99-
tools. For Jython we need our own naming convention, and to re-use the
100-
CPython tools. It is also worth considering whether we move away from
101-
bugs.jython.org to GitHub issues, and how we do that.
97+
bpo-NNNN is used by CPython for for bugs.python.org
98+
and is picked up by CPython's GitHub tools.
99+
For Jython we need our own naming convention, but cannot yet re-use the
100+
CPython tools.
101+
We intend to move away from bugs.jython.org to GitHub issues more aggressively
102+
that CPython has made the switch.
102103

103104
.. note::
104105

105106
First time contributors will need to sign the Contributor Licensing
106107
Agreement (CLA) as described in the :ref:`Licensing <cla>` section of
107108
this guide.
109+
This requires an account on the CPython's legacy bug tracker.
108110

109111

110112
Quick Links
@@ -113,7 +115,7 @@ Quick Links
113115
Here are some links that you probably will reference frequently while
114116
contributing to Jython:
115117

116-
* `Jython issue tracker`_
118+
* `Jython GitHub repository`_ (or maybe the `Jython issue tracker`_)
117119
* :doc:`help`
118120
* PEPs_ (Python Enhancement Proposals)
119121
* :doc:`gitbootcamp`
@@ -123,27 +125,21 @@ contributing to Jython:
123125
Status of Jython branches
124126
-------------------------
125127

126-
.. note:: Maybe how it should look in a process based on GitHub,
127-
and for Jython 3. Not how it is.
128-
129-
+--------+----------+-------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------+
130-
| Branch | Schedule | Status | First release | End-of-life | Comment |
131-
+========+==========+=============+===============+=============+=================================================================================================================+
132-
| master | | features | | | The default branch is currently the future Jython 3.5. |
133-
+--------+----------+-------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------+
134-
| 2.7 | | bugfix | | | The support has been extended to 2020 (1). |
135-
| | | | | | Most recent binary release: `Jython 2.7.1 |
136-
| | | | | | <http://search.maven.org/remotecontent?filepath=org/python/jython-installer/2.7.1/jython-installer-2.7.1.jar>`_ |
137-
+--------+----------+-------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------+
138-
| 2.5 | | end-of-life | | | Final release: `Jython 2.5.3 |
139-
| | | | | | <https://repo1.maven.org/maven2/org/python/jython/2.5.3/>`_ |
140-
+--------+----------+-------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------+
141-
142-
(1) The exact date of Python 2.7 end-of-life has not been decided yet. It will
143-
be decided by Python 2.7 release manager, Benjamin Peterson, who will update
144-
the :pep:`373`. Read also the `[Python-Dev] Exact date of Python 2 EOL?
145-
<https://mail.python.org/pipermail/python-dev/2017-March/147655.html>`_ thread
146-
on python-dev (March 2017).
128+
129+
+--------+----------+-------------+---------------+-------------+-----------------------------------------------------------------------------+
130+
| Branch | Schedule | Status | First release | End-of-life | Comment |
131+
+========+==========+=============+===============+=============+=============================================================================+
132+
| master | | bugfix | | | PSF support for Python 2 ended in 2020 (see :pep:`373`) but |
133+
| | | | | | the most recent release of Jython is still `Jython 2.7.2 |
134+
| | | | | | <https://search.maven.org/artifact/org.python/jython-installer/2.7.2/jar>`_ |
135+
+--------+----------+-------------+---------------+-------------+-----------------------------------------------------------------------------+
136+
| 3.8 | | features | | | This branch is the future of Jython. |
137+
| | | | | | (It should be master, but is just a gleam in the eye at present.) |
138+
+--------+----------+-------------+---------------+-------------+-----------------------------------------------------------------------------+
139+
| 2.5 | | end-of-life | | | Final release: `Jython 2.5.3 |
140+
| | | | | | <https://repo1.maven.org/maven2/org/python/jython/2.5.3/jar>`_ |
141+
+--------+----------+-------------+---------------+-------------+-----------------------------------------------------------------------------+
142+
147143

148144
Status:
149145

@@ -163,40 +159,18 @@ have reached end-of-life.
163159
The Jython project follows the Python Software Foundation in the naming of
164160
versions of the language (e.g. Jython 2.7 implements Python 2.7), and whether an
165161
implementation of that version has reached reached end-of-life.
162+
The third element (micro) has bears no relationship to CPython micro-versions.
166163

167164
See also :ref:`Security branches <secbranch>`.
168165

169-
Each release of Python is tagged in the source repo with a tag of the form
166+
Jython names its releases in the same scheme as CPython.
167+
Each release of Jython is tagged in the source repo with a tag of the form
170168
``vX.Y.ZTN``, where ``X`` is the major version, ``Y`` is the
171169
minor version, ``Z`` is the micro version, ``T`` is the release level
172170
(``a`` for alpha releases, ``b`` for beta, ``rc`` release candidate,
173171
and *null* for final releases), and ``N`` is the release serial number.
174172
Some examples of release tags: ``v3.7.0a1``, ``v3.6.3``, ``v2.7.14rc1``.
175173

176-
The code base for a release cycle which has reached end-of-life status
177-
is frozen and no longer has a branch in the repo. The final state of
178-
the end-of-lifed branch is recorded as a tag with the same name as the
179-
former branch, e.g. ``3.3`` or ``2.6``. For reference, here are the
180-
most recently end-of-lifed release cycles:
181-
182-
+------------------+--------------+-------------+----------------+----------------+----------------------------------------------------------------------------+
183-
| Tag | Schedule | Status | First release | End-of-life | Comment |
184-
+==================+==============+=============+================+================+============================================================================+
185-
| 3.3 | :pep:`398` | end-of-life | 2012-09-29 | 2017-09-29 | `Final release: Python 3.3.7 |
186-
| | | | | | <https://www.python.org/downloads/release/python-337/>`_ |
187-
+------------------+--------------+-------------+----------------+----------------+----------------------------------------------------------------------------+
188-
| 3.2 | :pep:`392` | end-of-life | 2011-02-20 | 2016-02-20 | `Final release: Python 3.2.6 |
189-
| | | | | | <https://www.python.org/downloads/release/python-326/>`_ |
190-
+------------------+--------------+-------------+----------------+----------------+----------------------------------------------------------------------------+
191-
| 3.1 | :pep:`375` | end-of-life | 2009-06-27 | 2012-04-11 | `Final release: Python 3.1.5 |
192-
| | | | | | <https://www.python.org/downloads/release/python-315/>`_ |
193-
+------------------+--------------+-------------+----------------+----------------+----------------------------------------------------------------------------+
194-
| 3.0 | :pep:`361` | end-of-life | 2008-12-03 | 2009-01-13 | `Final release: Python 3.0.1 |
195-
| | | | | | <https://www.python.org/download/releases/3.0.1/>`_ |
196-
+------------------+--------------+-------------+----------------+----------------+----------------------------------------------------------------------------+
197-
| 2.6 | :pep:`361` | end-of-life | 2008-10-01 | 2013-10-29 | `Final release: Python 2.6.9 |
198-
| | | | | | <https://www.python.org/download/releases/2.6.9/>`_ |
199-
+------------------+--------------+-------------+----------------+----------------+----------------------------------------------------------------------------+
200174

201175
.. _contributing:
202176

@@ -297,14 +271,9 @@ Key Resources
297271
-------------
298272

299273
* Coding style guides
300-
* Jython's `Java coding standard <https://wiki.python.org/jython/CodingStandards>`_
274+
* Jython's `Java coding standard`_
301275
* :PEP:`8` (Style Guide for Python Code)
302-
* `Jython issue tracker`_
303-
* `Meta tracker <http://psf.upfronthosting.co.za/roundup/meta>`_ (issue
304-
tracker for the issue tracker)
305-
* :doc:`experts`
306276
* Source code
307-
* `Browse in Mercurial online <http://hg.python.org/jython/file/default/>`_
308277
* `Browse in GitHub <https://github.com/jython/jython/>`_
309278

310279
* PEPs_ (Python Enhancement Proposals)
@@ -421,4 +390,6 @@ you understand the Jython one.
421390
.. _Issue tracker: https://bugs.python.org/
422391
.. _open pull requests: https://github.com/jython/jython/pulls?utf8=%E2%9C%93&q=is%3Apr%20is%3Aopen%20label%3A%22awaiting%20review%22
423392
.. _Jython issue tracker: https://bugs.jython.org/
393+
.. _Jython GitHub repository: https://github.com/jython/jython
394+
.. _Java coding standard: https://wiki.python.org/jython/CodingStandards
424395
.. _Style Guide for Java code: http://www.oracle.com/technetwork/java/codeconvtoc-136057.html

‎patch_hg_jy.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Lifecycle of a Patch (Mercurial)
99
.. note::
1010
This has been adapted for Jython from an old version of the CPython devguide,
1111
to describe the Jython process based on Mercurial.
12+
We retain this (for the time being) for reference.
1213

1314
Creating
1415
--------

0 commit comments

Comments
 (0)