Issue #4625
closed
pulpcore contirbuting guide is duplicated and contains version/branching info
Description
This outlines a few changes needed to clarify our contributor docs:
1. The versioning section parts ( https://docs.pulpproject.org/en/3.0/nightly/contributing/git.html#versions-and-branches ) should move to the homepage as a statement about Pulp's versions. It's not part of the contributor process for Pulp3.
2. Remove mention of cherrypicking (we don't have a process in pulp3 for this)
3. Remove reference to PUP-0003 since it's not currently a process we use right now and all the branching is confusing to read about as part of the pulp3 docs.
Updated by bmbouter over 5 years ago
- Subject changed from pulpcore versions and branches docs are out of date to pulpcore contirbuting guide is duplicated and contains version/branching info
- Description updated (diff)
revises to be more clear about specifically what to change.
Updated by amacdona@redhat.com over 5 years ago
+1 move to homepage.
Please leave a link to this info in the contributor guide.
Updated by bmbouter over 5 years ago
@asmacdo, I didn't understand a link in the contributor guide to where?
Updated by amacdona@redhat.com over 5 years ago
These docs were in the contributor guide because they help the contributor to understand the branching strategy, which is necessary before making a PR. I agree that this is more generally useful than that situation, so the homepage is preferred. Still the contributing guide should link to this info on the homepage to continue to fill its original purpose. (Personally, I wouldn't think to look on the homepage.)
Updated by bmbouter over 5 years ago
I think what I'm pointing out is that for pulp3 for the foreseeable future we won't be using this branching strategy. So part of the goal is to not have them thing of branching at all. The idea with moving to the homepage is that users should be told more up front about our semver commitment. What do you think about this?
Updated by bmbouter over 5 years ago
- Status changed from NEW to ASSIGNED
- Assignee set to bmbouter
Updated by bmbouter over 5 years ago
- Status changed from ASSIGNED to POST
PR available at: https://github.com/pulp/pulpcore/pull/65
Added by bmbouter over 5 years ago
Updated by bmbouter over 5 years ago
- Status changed from POST to MODIFIED
Applied in changeset pulpcore|8b37c74d9145475a5fa41aa1f62f3aaa62c570e9.
Updated by bmbouter about 5 years ago
- Status changed from MODIFIED to CLOSED - CURRENTRELEASE
.
Revamps the git contributor page
This moves the version section to the homepage and then links to that from the git page. The branching page now recommends all code be opened in a Pull Request against the master branch.
https://pulp.plan.io/issues/4625 closes #4625