Project

Profile

Help

Issue #4625

pulpcore contirbuting guide is duplicated and contains version/branching info

Added by bmbouter 7 months ago. Updated 6 months ago.

Status:
MODIFIED
Priority:
Normal
Assignee:
Category:
-
Sprint/Milestone:
Start date:
Due date:
Severity:
2. Medium
Version:
Platform Release:
Blocks Release:
OS:
Backwards Incompatible:
No
Triaged:
No
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation
QA Contact:
Complexity:
Smash Test:
Verified:
No
Verification Required:
No
Sprint:

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.

Associated revisions

Revision 8b37c74d View on GitHub
Added by bmbouter 7 months ago

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

History

#1 Updated by bmbouter 7 months 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.

#2 Updated by amacdona@redhat.com 7 months ago

+1 move to homepage.

Please leave a link to this info in the contributor guide.

#3 Updated by bmbouter 7 months ago

@asmacdo, I didn't understand a link in the contributor guide to where?

#4 Updated by amacdona@redhat.com 7 months 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.)

#5 Updated by bmbouter 7 months 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?

#6 Updated by bmbouter 7 months ago

  • Status changed from NEW to ASSIGNED
  • Assignee set to bmbouter

#7 Updated by bmbouter 7 months ago

  • Status changed from ASSIGNED to POST

#8 Updated by bmbouter 7 months ago

  • Status changed from POST to MODIFIED

#9 Updated by daviddavis 6 months ago

  • Sprint/Milestone set to 3.0

#10 Updated by bmbouter 6 months ago

  • Tags deleted (Pulp 3)

Please register to edit this issue

Also available in: Atom PDF