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

[DOC] - Clarification for which branch to open labs blog post PRs against. #900

Open
steppi opened this issue Jan 24, 2025 · 0 comments
Open

Comments

@steppi
Copy link
Contributor

steppi commented Jan 24, 2025

Currently the README contains the following language

Quansight-website/README.md

Lines 149 to 151 in a3742d0

Note that Labs blog posts are a bit of an exception. Categorically they are
content changes, but the content lives in the Git repo -- so technically they are
code changes, and they follow the process for code changes.

and the process for code changes states the following

Quansight-website/README.md

Lines 206 to 210 in a3742d0

### Code changes (GitHub) 💻
Code changes move through three stages, each of which corresponds to a branch in
git: a feature branch (PR), then the `develop` branch, then `main`. When your
code gets merged to the `main` branch, Vercel deploys it to the public website.

and following these instructions, I opened the PR for a blog post against the develop branch here, #892 1. This PR has since been approved and merged.

After this PR got merged, I then noticed that I'd missed the following instructions:

7. Create a pull request to the `main` branch. Make sure to add the `type: content 📝`
and `labs 🔭` labels to the PR.

which seem to contradict the above instructions. I also found that many labs blog post PRs have been opened against main, but the particular one I checked as a reference happened to be opened against develop.

I have the following questions.

  1. Is the proper process for labs blog posts to open PRs against develop or main?
  2. Can we update the README to consistently reflect the proper process?
  3. What is the best way to get my post which has been merged into develop added to main and deployed? Is there anything in particular I need to do? I was thwarted when trying to follow these instructions:

Quansight-website/README.md

Lines 234 to 239 in a3742d0

```sh
git checkout develop
git pull
git checkout -b release-YYYYMMDD
git push -u origin release-YYYYMMDD
```

because there were merge conflicts between develop and main that I didn't feel qualified to resolve.

Should I just create a new PR that cherry-picks the squash-merged commit from develop and target it against main?

Footnotes

  1. I had actually originally opened a PR against main here, https://github.com/Quansight/Quansight-website/pull/891, but closed
    it and opened a new one against develop because I thought that was the proper process.

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

1 participant