-
Notifications
You must be signed in to change notification settings - Fork 84
Workflow for code changes
Michael Wetter edited this page Feb 17, 2014
·
6 revisions
This page describes the workflow for changing source code and documentation. Eventually, as the design becomes more stable, we will define a stricter process. At this stage of the development, code changes should be done as follows:
- Open a new issue, and assign it to the one who can address it (which may be you).
- Make a new branch starting from the
master
branch. Call this branch something likeissue17_enthalpySensor
, that is, use the issue number and a brief description of the revised feature. - Document your changes on the issue tracker and implement them on the branch. You may want to include in the commit message a string such as
#17
. This will automatically add a link to the commit from the issue. - When done with the implementation,
- merge the latest version from the
master
to your branch,- run the unit tests,
- make a pull request from your branch to the
master
,- assign the issue to Michael for review and for merging it the master branch. (Conversely, Michael will assign his changes for review to someone else.)
- When reviewing other's code, add your comments on the issue tracker.
- If the revisions are reviewed and correct, merge the pull requests to the master, delete the branch and close the ticket. If the revisions need further work, assign the issue to the original author.
Note that only the person who reviewed the code will merge it to the master. Don't merge your own revisions without having them reviewed.