New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Content: A developer best-practices guide for NSHM projects #12

Open

chrisbc opened this issue Dec 17, 2024 · 1 comment

Labels

DOC documentation

Member

chrisbc commented Dec 17, 2024 •

edited

Loading

Describe our conventions and polices for different project types, covering ...

dependency pinning
project structure (source, resources, scripts, tests)
formatting, linting
git branching / merge / rebase preferences
naming conventions
CI/CD guidance
release & tagging
public artefacts (pypi etc)
changelogs
documentation
dependency and security updates
language version support

NB In many cases we can take our best example projects (nzshm-common, solvis, solvis-graphql-api) and use them as templates for the above

Classify our different projects styles:

python libraries
graphql APIs
user samples (e.g. jupyter notebooks)
API stitching and application APIs (api gateways )
UI applications (Weka, TUI, Kororaa
UI libraries

chrisbc added documentation DOC labels

Collaborator

chrisdicaprio commented Dec 17, 2024

add project structure to the list of guidlines?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment