From a2df3b3d95885035dab5367ad5cd9de52c930dda Mon Sep 17 00:00:00 2001 From: Andreas Rudolph Date: Mon, 9 Nov 2015 23:36:31 +0100 Subject: [PATCH] added contribution notes --- CONTRIBUTING.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c6ba179 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,49 @@ +# Contributing + + +## Notes about branches + +This project follows the principles of the +[GitFlow branching model](http://jeffkreeftmeijer.com/2010/why-arent-you-using-git-flow/) +as [proposed by Vincent Driessen](http://nvie.com/posts/a-successful-git-branching-model/). According to this model you +will find these branches at the GitHub project page: + +- The [master branch](https://github.com/OpenEstate/OpenEstate-PHP-Wrapper-Joomla/tree/master) contains the current stable + releases. No development is directly taking place in that branch. + +- The [develop branch](https://github.com/OpenEstate/OpenEstate-PHP-Wrapper-Joomla/tree/develop) represents the current state of + development. Changes from this branch are merged into + [master](https://github.com/OpenEstate/OpenEstate-PHP-Wrapper-Joomla/tree/master) when a new version is released. + +- For more complex features you may also find different feature branches. These are derived from + [develop branch](https://github.com/OpenEstate/OpenEstate-PHP-Wrapper-Joomla/tree/develop) 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](https://github.com/OpenEstate/OpenEstate-PHP-Wrapper-Joomla/tree/develop) as basis for your customization. Feel +> free to create separate feature branches for any custom feature you like to share. + + +## Create a pull request + +We love pull requests. Here's a quick guide. + +- Fork this project into you GitHub profile. + +- Clone the [develop branch](https://github.com/OpenEstate/OpenEstate-PHP-Wrapper-Joomla/tree/develop) of the repository to your + local disk: + ``` + git clone -b develop git@github.com:your-username/OpenEstate-PHP-Wrapper-Joomla.git + ``` + +- Do your changes to the local repository and push the changes back into your fork at GitHub. + +- [Submit a pull request](https://github.com/OpenEstate/OpenEstate-PHP-Wrapper-Joomla/compare/) 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](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).