kealanparr/software-development-standards

Standards and guidance relating to software development in Defra

Software development standards

This is the temporary home for standards and guidance relating to software development in Defra.

Contents

• Guides
  • Choosing packages
  • Continuous integration
  • Developer workflows
  • Docker guidance
  • Java auto-format with Eclipse
  • Kubernetes
  • Mobile application guidance
  • New starters
  • PL/SQL auto-format with TOAD
  • SQL Prompt
  • Style guide for standards
  • Using unmanaged devices
  • Version control guidance
• Principles
  • Coding principles
  • Security principles
• Processes
  • Credential exposure
  • Pull requests
• Standards
  • Common coding standards
  • Container standards
  • C# coding standards
  • Deployment standards
  • Development languages
  • Java coding standards
  • JavaScript standards
  • Kubernetes standards
  • Mobile application standards
  • Node.js standards
  • PL/SQL coding standards
  • Quality assurance and test standards
  • README standards
  • Ruby coding standards
  • Security standards
  • TSQL and SQL Server database standards
  • UiPath standards
  • Version control standards

About

These standards are part of our efforts to keep our work consistent and of a high quality across the services and projects we build and maintain.

They are based on an agreed set of principles.

It has been produced as a series of markdown files to make the process of adding and maintaining the documentation as simple as possible. Nothing is fixed and anything documented here is open to change.

It is maintained under source control to cater for this, allowing anyone to make suggestions for improvement via the standard pull request process.

It is pushed to GitHub to make it publicly accessible and to render the content in a presentable format.

It is heavily inspired by the work of ThoughtBot.

Contributing to this project

We encourage everyone to contribute to these standards!

We only ask that contributions are made using pull requests, where they can then be discussed and approved by the DEFRA/sds-group.

Please ensure you have read our principles first, and then contribution guidelines for details on how to get started.

License

THIS INFORMATION IS LICENSED UNDER THE CONDITIONS OF THE OPEN GOVERNMENT LICENCE found at:

http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3

The following attribution statement MUST be cited in your products and applications when using this information.

Contains public sector information licensed under the Open Government license v3

About the license

The Open Government Licence (OGL) was developed by the Controller of Her Majesty's Stationery Office (HMSO) to enable information providers in the public sector to license the use and re-use of their information under a common open licence.

It is designed to encourage use and re-use of information freely and flexibly, with only a few conditions.