Documentation

[jon-nfc]

Create project docs.

Details

basic dev workflow for CI to be based upon is as follows:

• master branch contains stable code
• devevopment branch is the un-stable code
• development branch is default branch
• feature branch is working branch for non-bug work
• development branch is working branch for bugs

1. work done on separate branch

2. separate branch merged to feature branch for non-bug work and merged to dev branch for bug work.

   1. any bug fix to dev must be cause the feature branch to be git pull --rebase origin development

3. feature branch merged to dev branch

   1. if release created it's not a full release (a,b,rc etc)

4. dev branch merged to master branch

5. on merge to master branch release to be created

   • merge to master to auto-magically create git tag

creation of a release only to occur on the tag created. all work to be done for a release is to be on the tag CI pipeline.

Links

• Releated feat: Add docker workflows #1
• Related Django Project #2
• Blocked By docs workflow creation

Requirements

• Publishes to website