This document stablish the process and workflows as per github and gitflow good practices (in some cases simplified and relaxed), if in doubt please take a peek here or here
This practices must appear so "elite" or "cathedral style" at first, but believe me you will thanks me for teaching you this if you pretend to work for a bigger or professional soft company. At the end and with the time you will see how easy is to pin-point any info from the entangle of branches, issues, travis, etc.
At first we will be easy with this but people, please catch the (git)flow ASAP.
Its all about issues, every change must have a reference issue in which the dev team can debate about, and branches that name the user and issue it's working on.
So if you need to do a change, fix something or add a new feature, please open an issue or feature for it. Once you have a issue number to work with, create a branch from latest develop in YOUR own fork and name it user_t#_short_description_of_issue see here where I created a branch named stdevPavelmc_t8_travis_integration
All commits comments must start with Refs #8, .... where in this case the #8 refers to the issue you are working on, why? see it here in action
Hover the mouse over the name, number and comments of the commit d4a19cd github does a great job by linking all together, this is possible because we mentiones the issue in the branch name and also in the commit comment.
Pull request are intentions to merge some code into the main tree, you can open a pull request of your local work at any time, the only condition is that you have pushed at least a commit for an issue.
In fact is a recommended practice, open an issue, analyze, make your first commit and open the pull request ride away; in this way changes will be picked by travis and CI/CD will fire to tell you if your changes are good o broke something.
As a general rule a pulll request must end with a comment on which you mentions @llamaret and estate that the pull request is ready to merge
The merge action by the repo owner (@llamaret) will automatically close the corresponding pull request and the issue just by adding a comment like this to the comment of the merge Closing issue #8... github will do the magic and will (if travis build is a success) close the PR and the matching issue, all in just one place.
This repo has travis-ci as CI/CD engine, see https://travis-ci.org/llamaret/MystiQ to check the status and latest tests.
Travis is configured to use your email for notifications of success/fail on the build you triggers, in the near future we will implements github & travis notifications to the Telegram channel (pending Issue for this)
Automatic deploys to github are in the plan for tomorrow (aka ASAP) and will cover at least builds for the following distros:
- Ubuntu Bionic (works on Debian 9/10)
- Windows
In all cases we will try to use 32/64 bits if possible.