Stripeline is a complex project, and we strive to keep it at the best quality. This document provides a few guidelines to ensure that the development is as much organic as possible and that the developers cooperate harmoniously.
To make Stripeline as much reliable as possible, we follow semantic versioning. Therefore, any significant change to Stripeline must thus be planned and discussed with the lead developers.
In general, you should never commit to the master branch. The
devel branch is the place where all the real stuff happens. To
implement significant changes to the codebase (e.g., API breakage, the
addition of significant features, etc.), you are expected to submit a
pull request (PR) to the devel branch. Once in a while, the main
developers take a look at all the features implemented in devel,
merge them to master and release a new version.
Start by creating a new branch under devel with git checkout -b. In this example, we name the branch my-awesome-feature and make
it visible on GitHub:
git checkout devel
git checkout -b my-awesome-feature
git push --set-upstream origin my-awesome-feature
(this example assumes that you named your remote branch on GitHub
origin; this is usually the default.)
At this time, you're ready to code! Be sure to commit frequently, so that other people can check how your work is proceeding. Don't worry if you are creating many small commits—they can be squashed together once your PR is ready!
To submit the pull request, fire your browser to https://github.com/lspestrip/Stripeline.jl and pick your branch from the drop-down list «Branch: …», then click on the button «Pull request» on the right.
- Check that your branch forked from
develand not frommaster - Update
CHANGELOG.mdwith a short description of your new features under the nameHEAD.