Skip to content

Docs: Expand CONTRIBUTING.md and update Brev Launchable architecture docs.#159

Open
brycelelbach wants to merge 2 commits intomainfrom
feature/update-contributing-and-architecture-docs
Open

Docs: Expand CONTRIBUTING.md and update Brev Launchable architecture docs.#159
brycelelbach wants to merge 2 commits intomainfrom
feature/update-contributing-and-architecture-docs

Conversation

@brycelelbach
Copy link
Collaborator

@brycelelbach brycelelbach commented Mar 11, 2026

Summary

  • Expand CONTRIBUTING.md with sections for developer setup, branches, commit message format, pre-commit hooks, development/validation/utility scripts, commit signing, and fork PR guidelines.
  • Add brev/requirements-dev.txt with the minimal Python developer dependencies (pre-commit, nbformat, nbconvert, hpccm).
  • Update docs/brev_launchable_architecture.md with tutorial directory structure, notebook naming conventions, exercise vs. solution notebook semantics, test infrastructure, and correct Docker Compose service names (nsys/ncu replacing the old nsight).

@brycelelbach brycelelbach enabled auto-merge (rebase) March 11, 2026 18:54
@brycelelbach brycelelbach force-pushed the feature/update-contributing-and-architecture-docs branch from 207773f to 95b1789 Compare March 11, 2026 21:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant