This project follows the principles of the GitFlow branching model as proposed by Vincent Driessen. According to this model you will find these branches at the GitHub project page:
-
The master branch contains the current stable releases. No development is directly taking place in that branch.
-
The develop branch represents the current state of development. Changes from this branch are merged into master when a new version is released.
-
For more complex features you may also find different feature branches. These are derived from develop branch and are merged back / removed as soon as the feature is ready for release.
Notice: If you like to provide changes to this project, you should always use the develop branch as basis for your customization. Feel free to create separate feature branches for any custom feature you like to share.
We love pull requests. Here's a quick guide.
-
Fork this project into you GitHub profile.
-
Clone the develop branch of the repository to your local disk:
git clone -b develop git@github.com:your-username/OpenEstate-Tool-Manual.git -
Do your changes to the local repository and push the changes back into your fork at GitHub.
-
Submit a pull request with the changes from your fork.
At this point you're waiting on us. We like to comment on pull requests as soon as possible. We may suggest some changes or improvements or alternatives.
Some things that will increase the chance that your pull request is accepted:
- Test your changes.
- Write a good commit message.