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
Copy Markdown
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 2 times, most recently from 95b1789 to b55764b Compare March 12, 2026 13:13
@brycelelbach brycelelbach force-pushed the feature/update-contributing-and-architecture-docs branch from b55764b to d7038d1 Compare March 30, 2026 17:07
@github-actions
Copy link
Copy Markdown
Contributor

❌ Link Check Failed

Broken links were detected in this PR.

Please check the workflow run logs for details on which links are broken.

Common fixes:

  1. Typo in URL - Check for spelling mistakes in the link
  2. Outdated link - The page may have moved or been deleted
  3. Relative path issue - Ensure relative links use the correct path
  4. External site down - If the external site is temporarily down, you can add it to brev/.lycheeignore

To test links locally:

./brev/test-links.bash .

📚 Lychee documentation

@brycelelbach brycelelbach force-pushed the feature/update-contributing-and-architecture-docs branch from d7038d1 to e5c765d Compare March 30, 2026 17:18
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