Skip to content


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
100644 28 lines (14 sloc) 2.269 kb
fd5f3ce @kaecyra Added README file.
kaecyra authored
1 # Vanilla Forums
eea55db @markosullivan Text update
markosullivan authored
3 **Welcome!** Vanilla was born out of the desire to create flexible, customizable, and downright entertaining community solutions. Vanilla has been used to power over 500,000 community forums around the world and we couldn't be happier that you've decided to use Vanilla to grow yours.
fd5f3ce @kaecyra Added README file.
kaecyra authored
5 # Source Control Ideology
7 To keep things simple and manageable, we've adopted the [git flow branching model]( in our projects. The creators of git flow have released a [short introduction video]( to explain their model.
9 ## master
11 The *master* branch of the vanillaforums repository will always contain our latest production (release) code. It should be the most stable source code you can download from us, but also the oldest. New code only gets into *master* when we release a new version or create a hotfix.
13 ## develop
d0f234f @kaecyra Fix typos in README.markdown
kaecyra authored
15 All of our unreleased development work ends up in the *develop* branch. Sometimes it is committed directly, other times it comes from merged hotfixes against a release, and other times it comes from a merged feature branch. This branch will always contain the most bleeding edge vanillaforums code, so it sometimes has bugs and unfinished features. Use this at your own risk, and avoid deploying it in production.
fd5f3ce @kaecyra Added README file.
kaecyra authored
78a9ce4 @kaecyra Update README to include reference to release branch
kaecyra authored
17 ## release
19 When we're getting ready to tag a release as a beta, we'll branch *develop* into *release*. This allows us to feature-freeze the code and more easily commit bug fixes without having to tediously create hotfix branches for every little thing. This code should be of beta or rc quality, for the most part, and is what you should download if you'd like to help us test.
fd5f3ce @kaecyra Added README file.
kaecyra authored
21 ## feature/x
23 Feature branches are work-in-progress branches that contain large chunks of new or modified code for a single feature or refactoring task. They are branched to preserve the stability of the *develop* branch during fairly destructive code changes.
25 ## hotfix/x
d0f234f @kaecyra Fix typos in README.markdown
kaecyra authored
27 Hotfixes are branched from *master* and exist to fix small bugs that are detected in a release after it has been tagged in *master*. These branches are usually small and concise, and are merged back into *master* and *develop* once they are completed. They should never be new features.
Something went wrong with that request. Please try again.