Topics to include in the developer guide
@vmartinez-cu is already working on this.
Since May 7, 2024.
Assessment
This issue has not been assessed yet.
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
- Dominant language
- Ruby
- Stars
- 3
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
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.
More from lasp/developer-guide
-
Topic
Difficulty 4/5 3-5 days Newbie friendliness 35/100
lasp/developer-guide#67 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
lasp/developer-guide#66 ·
-
Difficulty 5/5 Over a week Newbie friendliness 30/100
lasp/developer-guide#60 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
lasp/developer-guide#59 ·
-
lasp/developer-guide#54 · 1 assignee ·
All issues in lasp/developer-guide
Similar issues
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
TheOdinProject/curriculum#31408 ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
notch8/utk_knapsack#148 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
Homebrew/homebrew-cask#288729 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100