Skip to content

docs: add external contribution quick guide #40

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

Merged
ryan-lempka merged 5 commits into from
Jul 9, 2026
Merged

docs: add external contribution quick guide #40

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d3bc780
docs: add external contribution quick guide
ryan-lempka Jul 9, 2026
cea7592
chore: refresh detect-secrets baseline line numbers
ryan-lempka Jul 9, 2026
bfab827
docs: note DCO sign-off in internal workflow and correct required-che…
ryan-lempka Jul 9, 2026
b85f6d9
fix: point question contact link at this repo's Discussions
ryan-lempka Jul 9, 2026
d0e2ba2
chore: refresh detect-secrets baseline line numbers
ryan-lempka Jul 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,36 @@

Thank you for your interest in contributing! This document outlines the development workflow, testing practices, and code standards.

## External Contributions

We welcome contributions of all sizes, from typo fixes to new features. The short version:

1. [Fork the repository](https://github.com/NVIDIA-NeMo/Switchyard/fork) and clone your fork:

```bash
git clone https://github.com/YOUR-USERNAME/Switchyard.git
cd Switchyard
git remote add upstream https://github.com/NVIDIA-NeMo/Switchyard.git
```

2. Pick the right process for the size of your change:
- **Small changes** (typos, docs, focused bug fixes under ~100 lines): open a PR directly, no issue needed.
- **Larger changes** (new features, refactors, anything 100+ lines): [open an issue](https://github.com/NVIDIA-NeMo/Switchyard/issues/new/choose) first so maintainers can confirm the direction before you invest time.

3. Create a branch, make your change, and run the checks in [Code standards](#2-code-standards).

4. Commit with a DCO sign-off (see [Signing Your Work](#signing-your-work)):
Comment thread
ryan-lempka marked this conversation as resolved.

```bash
git commit -s -m "fix: description of the change"
```

5. Push to your fork and open a PR against `main`, linking any related issues (e.g. "Closes #42").

Review is requested automatically from the core team via [CODEOWNERS](.github/CODEOWNERS), so there is no need to pick reviewers. Keep each PR focused on one concern, include tests for behavior changes, and respond to feedback with follow-up commits rather than force-pushes.

Using AI tools to write code is fine, but you must understand and be able to explain every change in your PR.

## Setup

See [Development](DEVELOPMENT.md) for full setup instructions.
Expand Down
Loading