Editorial Guidelines (git workflow)

Suggested git workflows for edits post 1.0.1

Updates based on github issues

This is the preferred workflow so that updates can be tracked to the rationale.

1. Create branch off develop called issue-n where n is the issue number. (This can be done in github by first selecting the develop branch in the branch dropdown, and then entering the name of the new branch in the branch dropdown).
2. Make changes as required in the issue-n branch
3. Create a Pull request from the issue-n branch to the develop branch, and assign a review
4. Once the review is approved, merge the changes to the develop branch Note: documentation changes can be made using the online github editor. Select the correct branch before clicking the edit button in github.

Ad hoc schema updates

This might be used for minor schema updates (e.g. typographic errors) for which creating an issue would be overkill.

1. Create branch off develop called schema-yyyymmddhhmm. (This can be done in github by first selecting the develop branch in the branch dropdown, and then entering the name of the new branch in the branch dropdown).
2. Make changes as required in the schema-yyyymmddhhmm branch
3. Create a Pull request from the schema-yyyymmddhhmm branch to the develop branch, and assign a reviewer
4. Once the review is approved, merge the changes to the develop branch

Ad hoc documentation updates

This might be used for minor documentation updates (e.g. typographic errors) for which creating an issue would be overkill.

1. Create branch off develop called docs-yyyymmddhhmm. (This can be done in github by first selecting the develop branch in the branch dropdown, and then entering the name of the new branch in the branch dropdown).
2. Make changes as required in the docs-yyyymmddhhmm branch
3. Create a Pull request from the docs-yyyymmddhhmm branch to the develop branch, and assign a reviewer
4. Once the review is approved, merge the changes to the develop branch

Publishing a new version

1. Create branch off develop called releasing-vn.n.n where n.n.n is the version to be released.
2. Check that the version stamps and links are correct, making changes as required (see checklist below)
3. Create pull request to merge releasing-vn.n.n into the master branch, and assign a reviewer
4. Once review is approved, merge the changes into the master branch
5. Create a github release on master with the tag name vn.n.n, human readable title "LCF Version n.n.n"
6. Once merged into master, update the version stamps and links to the next version (see checklist below)
7. Create pull request to merge releasing-vn.n.n into the develop branch, and assign a reviewer
8. Once review is approved, merge the changes into the develop branch
9. Update the wiki Home page with the new version of the release standard, and add an historic link to the recently superseded version

Version Release Checklist

Known references to version which need to be checked\updated before release.

File	Line No.	Example Content	Comment
lcf-schema/pom.xml	22	1.0.1-SNAPSHOT	Remove -SNAPSHOT before merging into master, add -SNAPSHOT before merging into develop
lcf-schema/pom.xml	25	Implementation of the JAXB bindings for the BIC LCF Version 1.0.1 XML Schemas
lcf-schema/src/main/resources/lcf-v1.0-codelists.xsd	16	<xs:documentation source="https://bic-org-uk.github.io/bic-lcf/LCF-CodeLists#Issue">2</xs:documentation>
docs/_config.yml	3	title: LCF v1.0.1
docs/index.md	13	### Version 1.0.1
docs/index.md	15	### FINAL DRAFT, 12 July 2018	Remove any DRAFT note before merging into master
docs/LCF-DataFrameworks.md	13	### Version 1.0.1
docs/LCF-DataFrameworks.md	15	### FINAL DRAFT, 05 July 2018	Remove any DRAFT note before merging into master
docs/LCF-CodeLists.md	2	title: LCF v1.0.1 Code Lists
docs/LCF-CodeLists.md	15	### Issue 2
docs/LCF-CodeLists.md	17	### FINAL DRAFT, 05 July 2018	Remove any DRAFT note before merging into master
docs/LCF-InformationEntityXMLBindings.md	2	title: LCF v1.0.1 Information Entities XML bindings
docs/LCF-InformationEntityXMLBindings.md	15	### Version 1.0.1
docs/LCF-InformationEntityXMLBindings.md	17	### FINAL DRAFT, 05 July 2018	Remove any DRAFT note before merging into master
docs/LCF-InformationEntityXMLBindings.md	35	An XML schema that corresponds to this specification is available at https://github.com/bic-org-uk/bic-lcf/tree/v1.0.1/lcf-schema/src/main/resources.	The vn.n.n tag may not yet exist prior to release. Use https://github.com/bic-org-uk/bic-lcf/tree/develop/lcf-schema/src/main/resources whilst in draft
docs/LCF-RESTWebServiceSpecification.md	2	title: LCF v1.0.1 REST Web Services Implementation
docs/LCF-RESTWebServiceSpecification.md	15	### Version 1.0.1
docs/LCF-RESTWebServiceSpecification.md	17	### FINAL DRAFT, 05 July 2018	Remove any DRAFT note before merging into master
docs/LCF-AuthenticationAuthorisation.md	2	title: LCF v1.0.1 REST Authentication and Authorisation
docs/LCF-AuthenticationAuthorisation.md	15	### Version 1.0.1
docs/LCF-AuthenticationAuthorisation.md	17	### FINAL DRAFT, 05 July 2018	Remove any DRAFT note before merging into master
docs/LCF-ImplementationProfiles.md	2	title: LCF v1.0.1 Implementation Profiles
docs/LCF-ImplementationProfiles.md	15	### Issue 1
docs/LCF-ImplementationProfiles.md	17	### FINAL DRAFT, 05 July 2018	Remove any DRAFT note before merging into master