How to contribute to this repository
Clone this wiki locally
All ongoing work is happening in
master branch, as usual. All PRs should go there.
NOTE THAT PREVIOUSLY THERE WAS
-wip BRANCHES, but they're no more.
Contribute everything to master, as usual.
Common work process is as follows:
Fork YiiBooster to your Github account. Use button "Fork" in the Github webpage, and follow instructions afterwards.
Add Clevertech's repo as an additional remote to your fork.
git remote add ct git://github.com/clevertech/YiiBooster.gitNote that I named new remote as
ctin this example. Remember it.
masterbranch from Clevertech's repo.
git pull ctWhen you run just
git pullyou pull from the
originremote. This way you explicitly requires Git to pull from Clevertech's repository.
Make a new branch named after the feature you're fixing/adding.
git checkout -b myfeatureStep 3 ensures you that you're branching from most latest
master, this will save you a lot of pain when you'll be pull-requesting.
Commit everything to this feature branch and not to master. Easiest way is to run
git branchbefore commit and look if the asterisk is before the name of your desired branch.
After you've done with the feature under question, open the
CHANGELOG.mdand append the line to it in the following format:
- **(fix)** a description of the bug fix #issue_number (Your Name)or
- **(enh)** a description of the enhancement #issue_number (Your Name)
Commit this change to
CHANGELOG.mdnormally. It'll be included in your PR on next step and it's good. This step is proposed first in #167 and it's definitive. Please, do it.
Push this branch to your Github fork.
git push origin myfeatureNote that you use the remote named
originhere. It points to your fork of the YiiBooster.
After this, go to clevertech/YiiBooster, hit "Pull Request" and choose your branch at your fork as a source and
masterbranch as a receiver of pull request.
Please, do not forget to reference the original issue as '#'+issue-number in the description of your pull request. It's very important, it'll help admins to quickly find what issues can be closed with this pull request.
Please, I know, too, that it all is an ass-crunching hassle, however, Git along with Github forces us to work in such a way, thank you.