Participate in the design process by creating an issue to discuss your design.
We develop on the dev branch.
You can get the dev branch checked out using git checkout dev.
Fork cgm-remote-monitor and create a branch.
You can create a branch using git checkout -b wip/add-my-widget.
This creates a new branch called wip/add-my-widget. The wip
stands for work in progress and is a common prefix so that when know
what to expect when reviewing many branches.
When you are done working with your prototype, it can be tempting to post on popular channels such as Facebook. We encourage contributors to submit their code for review, debate, and release before announcing features on social media.
This can be done by checking your code git commit -avm 'my improvements are here', the branch you created back to your own
fork. This will probably look something like
git push -u origin wip/add-my-widget.
Now that the commits are available on github, you can click on the
compare buttons on your fork to create a pull request. Make sure to
select Nightscout's dev branch.
We encourage liberal use of the comments, including images where appropriate.
There is a google groups nightscout-core developers list where lots of people discuss Nightscout. Most cgm-remote-monitor hackers use github's ticketing system, along with Facebook cgm-in-the-cloud, and gitter system.
We use git-flow, with master as our production, stable branch, and
dev is used to queue up for upcoming releases. Everything else is
done on branches, hopefully with names that indicate what to expect.
Once dev has been reviewed and people feel it's time to release, we
follow the git-flow release process, which creates a new tag and bumps
the version correctly. See sem-ver for versioning strategy.
Every commit is tested by travis. We encourage adding tests to validate your design. We encourage discussing your use cases to help everyone get a better understanding of your design.