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.

Sign up for GitHub

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

VIDCS-3291: Update contributing doc to Reflect New Develop Branch Workflow #39

Merged
merged 6 commits into from
Feb 4, 2025
Merged

VIDCS-3291: Update contributing doc to Reflect New Develop Branch Workflow #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
bb6cca4
Update the contributing doc
dwivedisachin Jan 31, 2025
acdf0dd
pr template
dwivedisachin Jan 31, 2025
e4db417
formatting test
dwivedisachin Jan 31, 2025
94603bd
chris's feedback
dwivedisachin Jan 31, 2025
51730b4
gotcha
dwivedisachin Jan 31, 2025
9860bf4
mike's feedback
dwivedisachin Feb 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@


#### What are the relevant tickets?
A maintainer will add this ticket number.

Resolves [VIDCS-](https://jira.vonage.com/browse/VIDCS-)

#### Checklist
[ ] Branch is based on `develop` (not `main`).
[ ] 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](https://github.com/Vonage/vonage-video-react-app/issues/)?
[ ] If yes, did you close the item in `Issues`?
If yes, which issue? [Issue Number](https://github.com/Vonage/vonage-video-react-app/issues/)?
6 changes: 4 additions & 2 deletions docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,12 @@ We always welcome feedback, if you've seen something that isn't quite right or y

We're always open to pull requests, but these should be small and clearly described so that we can understand what you're trying to do. Feel free to open an issue first and get some discussion going.

When you're ready to start coding, fork this repository to your own GitHub account and make your changes in a new branch. Once you're happy, open a pull request and explain what the change is and why you think we should include it in our project.
When you're ready to start coding, fork this repository to your own GitHub account and make your changes in a new branch based on develop. Once you're happy, open a pull request to merge into develop and explain what the change is and why you think we should include it in our project.

### Branching

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. fix-broken-icon.

Release versions use the format rc-RELEASENUMBER number, e.g. rc-1.0.0. We use [semantic versioning](https://semver.org/) for our releases.
Loading