Skip to content
This repository was archived by the owner on Sep 20, 2019. It is now read-only.

Commit 26d4ca7

Browse files
committed
docs(workflow git branching): how this upstream well oiled machine should operate
1 parent e0e40f2 commit 26d4ca7

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

doc/workflow/git/branches.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
Github Branching Scheme
2+
=======================
3+
4+
There should be minimal branches in the main upstream of angular-ui/ui-leaflet.
5+
6+
Currently there should only be:
7+
8+
- master
9+
- gh-pages (active website)
10+
- leaflet-1.X (IE Some major next release branch)
11+
12+
Any an all other items as a dev **INCLUDING** admins and devs that have write permissions to the repo. Should work within their own fork
13+
and PR changes to this repository.
14+
15+
There are exceptions to this like accidents and major/minor collaboration branches (where many devs touch same code work together piror to being ready).
16+
17+
As an admin and dev with write permissions the majority of the time you should be submitting PRS. However if you need to push your changes to the upstream then please do the following.
18+
19+
Example Working in master:
20+
- `git checkout master`
21+
- `git merge upstream/master` (your in master)
22+
- `git push upstream`
23+
24+
Safer Example Working in master:
25+
26+
- `git checkout -t origin/master -b upstreamMaster`
27+
- `git merge upstream/master` (your in upstreamMaster)
28+
- `git push upstream`
29+
30+
Origin should be your personal fork and upstream should be angular-ui . If we need to explain this fully then you probably should not have admin nor write perms.
31+
32+
## Huge PRs (Many Commits)
33+
34+
If you can and you know what you are doing please rebase via `git rebase -i` to squash commits.
35+
36+
## Remember
37+
With great power comes great responsibility. If it is abused it will be taken awayith!

0 commit comments

Comments
 (0)