OCP Software Development Handbook

A guide for developers of OCP’s tools.

Remember

Put all deployment-related code in the deploy repository, not in the software repository. (Creating images is allowed in software repositories.)

• General
  • Documentation
  • Preferences
  • Code
  • API
• Python
  • Directory layout
  • Requirements
  • Preferred packages
  • Linting
  • Testing
  • Continuous integration
  • Documentation
  • Configuration
  • Logging
  • Django
  • File formats
  • General style
  • Internationalization (i18n)
  • Packages
  • Performance
• Rust
  • Development
  • Preferences
  • Code style
  • Troubleshooting
  • Continuous integration
  • Release process
  • Reference
• JavaScript
  • Version
  • Preferences
  • Requirements
  • Code style
  • Continuous integration
  • Reference
• Shell script
  • Directory layout
  • Shell options
  • Code style
  • Continuous integration
  • Reference
• SQL
  • Name conventions
  • Code style
  • Code format
  • Reference
• HTML and CSS
  • HTML
  • CSS
  • Reference
• Docker
  • .dockerignore
  • Dockerfile
  • Dockerfile for Django
  • Continuous integration
• Services
  • PostgreSQL
  • RabbitMQ
  • Administrative access
• Git
  • Commit messages
  • Feature branches
• GitHub
  • For developers
  • For users
  • For maintainers
  • For standards
  • Reference
• Roadmap
  • Product and service families
  • Principles
  • Reference
• Contributing
  • Policy proposal
  • Policy implementation
  • Reference

Useful resources

• The Good Services Principles and Scale

• 18F Engineering Practices Guide

• 18F De-risking Guide