VIDCS-3291: Update contributing doc to Reflect New Develop Branch Workflow #39
Conversation
docs/CONTRIBUTING.md
Outdated
| Our *main* branch is the evergreen source of truth for the Vonage Video API Reference App for React. Internally, we use Jira for issue tracking. Issue and feature branches use the format DEVELOPERNAME/TICKETNUMBER-SHORTDESCRIPTION e.g. alicesmith/VIDCS-123-fix-broken-icon. If you'd like to contribute a pull request, please use a branch on your fork with a descriptive name. | ||
| Our *main* branch is the evergreen source of truth for the Vonage Video API Reference App for React. However, all new development should be done in the develop branch. Contributions should be made by branching off develop, and pull requests should be submitted against develop. Periodically, develop will be merged into main as a batch. | ||
|
|
||
| Internally, we use Jira for issue tracking. Issue and feature branches use the format DEVELOPERNAME/TICKETNUMBER-SHORTDESCRIPTION e.g. alicesmith/VIDCS-123-fix-broken-icon. If you'd like to contribute a pull request, please use a branch on your fork with a descriptive name e.g. alicesmith/vonage-video-react-app/tree/fix-broken-icon. |
There was a problem hiding this comment.
Why have we added the repo name and tree to the example branch name? 🤔
There was a problem hiding this comment.
Hey Mike!! I is an example of a forked branch by an external user. For example https://github.com/mobilebiz/vonage-video-react-app/tree/double-byte-chat-input
There was a problem hiding this comment.
mmm I think that's confusing, the branch name in this example is still just fix-broken-icon
If we're giving them branch naming instructions then lets be direct, what do we want the branch name to be?
The fork owners name name and the tree are just part of github's linking system and will be there anyway since we have said to use your own fork.
(Otherwise people are going to be adding their whole remote + tree to the branch name)
What is this PR doing?
Update contributing doc to Reflect New Develop Branch Workflow.
See new contributing doc and PR template
How should this be manually tested?
n/a
What are the relevant tickets?
Resolves VIDCS-3291
[ ] Resolves a
Known Issue.[ ] If yes, did you remove the item from the
docs/KNOWN_ISSUES.md?[ ] Resolves an item reported in
Issues.If yes, which issue? Issue Number?
[ ] If yes, did you close the item in
Issues?