CHANGELOG format

[Ragazzo]

@tonydspaniard may be use format like in yii repo, because its good and very helpful to find info about changes and PR that was made?

[tonydspaniard]

Agreed @Ragazzo but I seriously need help here... I am so busy and I am currently working to update to YiiBooster 1.0.6, wish to include a couple of other widgets and I have to update at the same time Yiibooster site.

For docs, Pinocchio is fine... I think that after version 1.0.6 I will hold my self a bit to add more widgets (I have about 8 more to add) and will work on the API documentation. The docs should be written within the comments of the files, then with Pinocchio we can build a seriously cool API doc.

[Ragazzo]

8 more widgets, cool) i will try to update new changelog format and rows in it. (will search for PR numbers to make chagelog like in yii repo).

[sauloonze]

How about to use the step 7 from https://github.com/yiisoft/yii/wiki/Git-workflow-for-Yii-contributors ?

7. Update the CHANGELOG

Edit the CHANGELOG file to include your change, you should insert this at the top of the file under the "Work in progress" heading, the line in the change log should look like one of the following:

Bug #999: a description of the bug fix (Your Name)

Enh #999: a description of the enhancement (Your Name)

#999 is the issue number that the Bug or Enh is referring to.
The changelog should be grouped by type (Bug,Enh) and ordered by issue number.

For very small fixes, e.g. typos and documentation changes, there is no need to update the CHANGELOG.

[tonydspaniard]

Hi think makes a lot of sense and is actually the right way to go...

[kazuo]

Just making sure if I'm reading this correctly. If we send a PR, we should update CHANGELOG with that PR?

[Ragazzo]

yes, like in Yii repo wiki is written.

[hijarian]

Well, I've added this step to the wiki as an additional step to take when contributing. In dc57204 I've edited the README.md to mention this page in "Contributing" section.

I suppose this issue can be closed now.

@tonydspaniard @Ragazzo @kazuo @sauloonze

[udnisap]

I am bit confused.
2 in https://github.com/clevertech/YiiBooster/wiki/How-to-contribute-to-this-repository should be
git clone git://github.com/<your name>/YiiBooster.git

and I would suggest to merge the contributor's code to the wip branch before the pull request so the work load would be less.

[hijarian]

@rumal Ooops... true, I mixed up two different things there. Main point of checking out the Clevertech's repo is that you'll create a new feature branch from the most current *-wip branch. Given this and the point number 1 then point number 2 is completely unnecessary, you should rather merge...

I changed the proposed workflow to better explain what you should do to make contribution the easiest way.
The goal is to have a PR which pushes to most_current *-wip branch and so has only the changes relevant to feature in question. If you can do it some other way, you're welcome.