Making Changes - GreenImp/bill-bootstrap GitHub Wiki
Before you start
Bill is happily Open Source and free for everyone to use and/or modify. We welcome any suggestion for changes/bug fixes.
As Bill is developed through Git, it's very easy for anyone to grab a copy of the code and make their own changes, then push them back up to us, to include in a release.
If you've not used Git before or are unsure as to how it works, I suggest you read up on their website: http://git-scm.com/
There are also a lot of good GUIs out there, that can help you:
- Git list some on their website: http://git-scm.com/downloads/guis
- SourceTree is probably the best I've used (for Mac & Windows) FREE
- PHPStorm is a full development IDE, which has built in Git handling (for Mac, Linux & Windows)
Getting started
If you haven't already, you need a copy of the repository. Please create your own 'fork', rather than cloning (Why Fork?).
Branching and features
As mentioned in the Branches section, we use the Git Flow branching model.
In short terms, this means that you should make all of your changes to the develop branch.
You're more than welcome to create your own branches, from develop (see Branches for more), but you should never touch the master branch.
The master branch is the live, release branch and any changes here are deemed to be un-breaking and safe to use;
therefore, any changes should be made to the develop branch. We can then test those changes, before merging with master.
Any pull requests that modifying the master branch will probably be denied, to ensure that Bill doesn't break
Standards
Please read our Coding Standards page.
I've finished, look at all my awesome code guys!
First, make sure that you've compiled the minimized versions of any CSS/JS (see Pre-compiling).
Once you've made your changes and committed them, please ensure that your version is up-to-date (pull down any changes from the live develop branch and merge with yours).
Then you can push up your changes, to your own 'fork' of Bill, and make a Pull Request.
This will then allow us (or other developers) to view your changes, make any comments and/or approve them.
Once approved, we will then merge your changes into the main repository.
After the changes have been merged, we'll be able to run it through our various testing processes on the supported devices. If it's all okay, then we'll merge it into the next release of Bill.
You are now officially awesome and thank you for helping the development!