devguide icon indicating copy to clipboard operation
devguide copied to clipboard

How to manage the "alternate" devguide branch for PEP 588?

Open Mariatta opened this issue 6 years ago • 1 comments

For PEP 588's purpose, we want to have an alternate branch of the devguide where the new workflow of using GitHub issues can be documented, and we want to have this branch ahead of the migration. Sounds to me we will have to maintain two devguide branches: master branch and github-issues branch.

  1. Which branch will be default?
  2. Do we backport from one branch to another? From which branch?

I don't remember anymore how this was done when we migrated the codebase from hg to GitHub.

Mariatta avatar Aug 07 '19 20:08 Mariatta

I would expect that you maintain the github-issues branch as a branch of master, just like we do for branches of cpython master. Rather than 'backport' you occasionally merge upstream/master into github-issues. I don't know if you are using the fork workflow for other repositories or if people just push to python/whatever.

One way to make a formatted (html) version of the alternate available to read would be to check it in, possible into a separate branch. I keep a trailing-whitespace-trimmed copy of idle.html in idlelib so that people can read it from the IDLE menu without being online. (The copy function is in idlelib/help.py.) Git has no problem with html.

terryjreedy avatar Aug 07 '19 22:08 terryjreedy

The migration is now done (https://github.com/psf/gh-migration/issues/13) and the devguide has been updated (https://github.com/python/devguide/pull/814), let's close this.

hugovk avatar Dec 23 '22 09:12 hugovk