NSDF Software Development Life Cycle Procedures

Documents

• Introduction
  • Software checklist
  • Programming languages and conventions
    • C/C++
    • Python
    • Go
    • JavaScript
    • Awesome List
  • Links/Bibliography
• Continuous Integration
  • Version control
  • Git branches
  • Git workflows
  • Semantic Versioning
  • Code reviews
  • Links/Bibliography
• Continuous Delivery and Deployment
  • Cloud Deployment
  • Artifacts Repositories
  • Deployment staging
  • Docker Containerization
  • Kubernetes Orchestration
  • High-Performance Computing Deployment
  • Links/Bibliography
• Continuous Testing
  • Test-driven development
  • Unit testing and frameworks
    • Mocking
    • Unit testing frameworks
    • C++ Unit testing
    • Python Unit testing
    • Go Unit Testing
  • Other tests
  • Code Analysis
    • C++ Code Analysis
    • Python Code Analysis
  • Links/Bibliography
• Continuous Documentation
  • Markdown
  • Documentation as Code
  • Code as Documentation
    • Use intention-revealing names
    • Refactor long blocks
    • Use informative comments
    • Use class-level documentation
    • Use method-level documentation
    • Use proper formatting
    • Use error handling
    • C++ Documentation
    • Python Documentation
  • Jupyter Notebooks Documentation
  • Web Services API Documentation
    • Representational State Transfer (RESTful) API
    • RESTful documentation
  • Links/Bibliography
• Continuous Monitoring
  • Kubernetes monitoring
    • Container Advisor, Prometheus, Grafana
    • ElasticSearch, Logstash, Kibana
    • Other K8s monitoring/Logging solutions
  • Links/Bibliography
• Software Security
  • Enforce Security of sensitive data
  • Enforce Security of Continuous Integration
  • Enforce Security of Continuous Deployment
  • Security Scans
  • Automatic tools
  • Links/Bibliography
• Software Quality
  • Reliability
  • Efficiency
  • Security
  • Maintainability
  • Rate of Delivery
  • Automatic Tools
  • Links/Bibliography
• Appendix I. Git Workflows
  • Centralized Workflow
  • Feature Branching Workflow
  • Gitflow Workflow
  • Forking Workflow
  • GitHub Flow