Coding Conventions

Owned by Coldstream, George (STFC,RAL,SC)

Last updated: Aug 13, 2024 by Alexander Shepherd (Unlicensed)

1 min read

Style Guides: https://stfc.atlassian.net/wiki/spaces/CLOUDKB/pages/232783897 - A guide for consistent coding styles in Python.

Version Control: https://stfc.atlassian.net/wiki/spaces/CLOUDKB/pages/232849415 - A guide for setting up a repository for version control and setting up branch protections, repo access etc.

Git Conventions: https://stfc.atlassian.net/wiki/spaces/CLOUDKB/pages/232554517 - A guide for consistent version control, creating branches, commit messages etc.

Testing Conventions: https://stfc.atlassian.net/wiki/spaces/CLOUDKB/pages/232685598 - A guide on unit tests in Python

Performance Considerations: https://stfc.atlassian.net/wiki/spaces/CLOUDKB/pages/601260033 - A guide on some methods that will help maintain good performance when coding.

Security Considerations: https://stfc.atlassian.net/wiki/pages/resumedraft.action?draftId=609517584&draftShareId=20bf296f-7a39-4611-bb2a-775d339f5036 - A guide on the kinds of security considerations to have, while creating coded solutions.