diff options
| author |  Dieter Plaetinck <dieter@plaetinck.be> | 2009-11-29 11:42:02 +0100 |
|---|---|---|
| committer | Dieter Plaetinck <dieter@plaetinck.be> | 2009-11-29 11:42:02 +0100 |
| commit | 88eb4f2b6499529852db0695ffa1ad19432fd4c7 (patch) | |
| tree | 981d77e4dc6426bc247616a62d1ded4e6c3662cc /docs | |
| parent | 0fa88b2764c159dfd900796ae06901eb719983c8 (diff) | |
document slightly different branch usage + note about make tests in contribute section
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/COMMUNITY | 2 | ||||
| -rw-r--r-- | docs/CONTRIBUTING | 9 | ||||
| -rw-r--r-- | docs/INSTALL | 6 |
3 files changed, 7 insertions, 10 deletions
diff --git a/docs/COMMUNITY b/docs/COMMUNITY index e1498bb..2817ee9 100644 --- a/docs/COMMUNITY +++ b/docs/COMMUNITY @@ -21,8 +21,6 @@ COMMUNITY * [www.uzbl.org/bugs/](http://www.uzbl.org/bugs/) ### Code repositories -Remember: dieter/master = official stable branch. -If you want to develop, develop against dieter/experimental * [github.com/Dieterbe/uzbl](http://github.com/Dieterbe/uzbl/) * [github.com/anydot/uzbl](http://github.com/anydot/uzbl/) diff --git a/docs/CONTRIBUTING b/docs/CONTRIBUTING index a45618a..bcfd108 100644 --- a/docs/CONTRIBUTING +++ b/docs/CONTRIBUTING @@ -32,10 +32,8 @@ Read on for more info... * [Guides: Fork a project and submit your modifications](http://github.com/guides/fork-a-project-and-submit-your-modifications) 2. Do your work, test it and push to your repo. It may be interesting to ask - others for input on your work. Make sure you do not develop against the - master branch! It is meant for stable, tested code. - All contributors develop in their experimental or other specific branches, - which get merged into the mainline experimental, and after QA it gets merged into the main master. + others for input on your work. Develop against master for small changes/fixes, + experimental or a new topic branch for experimental/intrusive work. 3. If you think your code should be in the main uzbl code and meets all requirements (see below), then ask Dieter to merge it. @@ -65,7 +63,8 @@ This is a relatively easy, solid and transparent way to handle all requests in o * We recommend you finish your stuff first and then let Dieter know you want your stuff to be merged in, but we know for bigger changes this is not always feasible. Just try to keep the merges about bigger "clean changesets". * Your code should not introduce any compile warnings or errors. And also, - no regressions but that's harder to check. + no regressions but that's harder to check. Always run `make tests` to run + the test suite. * Please try to keep the code clean - we don't like extraneous whitespace. The sample pre-commit hook can check for this - so go ahead and $ cp .git/hooks/pre-commit.sample .git/hooks/pre-commit diff --git a/docs/INSTALL b/docs/INSTALL index 2e736cf..060add4 100644 --- a/docs/INSTALL +++ b/docs/INSTALL @@ -53,8 +53,8 @@ Git Repo's & branches -------------------- * Main official repo: http://github.com/Dieterbe/uzbl -- master -> uzbl stable branch -- experimental -> bleeding edge stuff that may break. after QA Dieter merges into his master - +- master -> main development branch +- experimental -> intrusive/experimental stuff +- <..> -> specific topic branches that come and go. they are a place to work on specific features * Most contributors & developers also have their clones on github (http://github.com/dusanx, http://github.com/Barrucadu/uzbl, ...). They may be developing specific features, which get merged into Dieters experimental branch |