Topics to include in the developer guide
Open
@vmartinez-cu is already working on this.
Since May 7, 2024.
Topic
- Dominant language
- Ruby
- Stars
- 3
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
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 (#21)
- Docker/containerization Guidelines (#25)
- GitHub / Open Source Guidelines (#32) (#38)
- NetCDF Formatting Guidelines (#24)
- Web Team Best Practices
- Python Best Practices (#51)
- Python Environment Management Guidelines
- Python Packaging and Distribution Guidelines (#26)
- Generative AI Tools at LASP (#50)
- Data Management (#42) (#45)(#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 (#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
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.