Skip to content
OMSF Playbooks
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Using this site
Developer Playbook
Using the Developer Playbook
Code Style and Quality
Add Type Checking
Don't Repeat Yourself (DRY)
Enforce Your Chosen Code Style
Minimize Code Complexity
Pick Code Style
Strive for High Code Coverage
Use Conventional Commits
Continuous Integration
Pick a CI provider
Run CI after every push to a pull request against main
Repository Structurue
Pick a Location for Your Docs
Use a Src or Flat Layout
Testing
Run Your Tests in CI
Write Concise Unit Tests
Write Integration Tests
Project Playbook
Using the Project Playbook
Fiscal and Strategic Alignment
Fiscal Sponsorship
Alignment with OMSF
Governance
Introduction
Why: The three functions of governance structures
How: The elements of government
Bylaws
Governing Board
Making Decisions
Benchmarking Playbook
Introduction
What is a Benchmark?
Why should you care?
Challenges
GitHub
Select theme
Dark
Light
Auto
Pick Code Style
What:
Use a format/style for all of your code and tests
Why:
Having a consistent style makes contribution easier and ensures code quality.
Recommendation:
PEP 8
Resources:
https://peps.python.org/pep-0257/
https://numpydoc.readthedocs.io/en/latest/format.htm
https://google.github.io/styleguide/pyguide.html
