Skip to content
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

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

Closed
Mariatta opened this issue Aug 7, 2019 · 2 comments
Closed

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

Mariatta opened this issue Aug 7, 2019 · 2 comments

Comments

@Mariatta
Copy link
Member

Mariatta commented Aug 7, 2019

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.

@terryjreedy
Copy link
Member

terryjreedy commented Aug 7, 2019

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.

@hugovk
Copy link
Member

hugovk commented Dec 23, 2022

The migration is now done (psf/gh-migration#13) and the devguide has been updated (#814), let's close this.

@hugovk hugovk closed this as completed Dec 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants