Topics to include in the developer guide #6
Description
The purpose of this issue is to maintain a running list of topics we wish to eventually document in this developer guide. Each of these topics should eventually have their own GitHub issue to allow for more focused discussion and development. This list is expected to change/evolve as this effort progresses!
Already Exists Somewhere
- Licensing Guidelines (Add licensing guidelines to ReadtheDocs #21)
- Docker/containerization Guidelines (Initial Docker guidelines #25)
- GitHub / Open Source Guidelines (Add guide on citing software #32) (Add a guide on LASP GitHub organization #38)
- NetCDF Formatting Guidelines (Add new guide on netCDF file format #24)
- Web Team Best Practices
- Python Best Practices (Add Python Best Practices Section #51)
- Python Environment Management Guidelines
- Python Packaging and Distribution Guidelines (Python packaging and distribution #26)
- Generative AI Tools at LASP (Add Generative AI Guidelines #50)
- Data Management (Add guidelines on metadata and FAIR principles #42) (Add data stewardship guide #45)(Add dataset publishing and citation content #57)
- Jenkins Job Builder
Definite
- Version Control (GitHub, GitLab, BitBucket, etc.)
- git workflow (Forking workflow, Branching workflow, etc.)
- CI/CD (GitHub Actions, Jenkins, etc.)
- Code of Conduct
- Versioning (semantic, time-based, etc.)
- API Documentation (OpenAPI, etc.)
- Unit Testing
- Accessibility Standards
- CDF Data Format
- Publishing and Citation (Add dataset publishing and citation content #57)
Maybe
- Issue Tracking (GitHub, JIRA, etc.)
- Software Environment Management (
Poetry,Conda, etc.) - Installation and Usage documentation
- Security
- Release workflows (GitHub Actions, Jenkins, etc.)
- Logging
Nice to Have
- SDC Architectures
- Dependency Updates
- Slack communication/culture
- Training catalog