Skip to content

chore: Wrap long lines in CONTRIBUTING.md #782

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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ValerianRey merged 1 commit into from
Sep 23, 2026
Merged

chore: Wrap long lines in CONTRIBUTING.md #782

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 13 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,22 @@ This document explains how to contribute to TorchJD.

## Getting Started

- **Minor changes** (bug fixes, documentation, small improvements): Open a pull request directly following the guidelines in this document.
- **Significant or major changes** (new features, API changes, architectural decisions): Join the [SimplexLab Discord server](https://discord.gg/76KkRnb3nk), introduce yourself and your idea, and discuss it with the community to determine if and how it fits within the project's goals before implementing.
- **Minor changes** (bug fixes, documentation, small improvements): Open a pull request directly
following the guidelines in this document.
- **Significant or major changes** (new features, API changes, architectural decisions): Join the
[SimplexLab Discord server](https://discord.gg/76KkRnb3nk), introduce yourself and your idea, and
discuss it with the community to determine if and how it fits within the project's goals before
implementing.

## Code Ownership

This project uses a [CODEOWNERS](CODEOWNERS) file to automatically assign reviewers to pull requests
based on which files are changed. The code owners are the people or groups who created or maintain
specific parts of the codebase.

When you open a pull request, GitHub will automatically request reviews from the relevant code owners
for the files you've modified. This ensures that changes are reviewed by the people most familiar
with the affected code.
When you open a pull request, GitHub will automatically request reviews from the relevant code
owners for the files you've modified. This ensures that changes are reviewed by the people most
familiar with the affected code.

## Installation

Expand Down Expand Up @@ -100,7 +104,10 @@ uv run pre-commit install
We encourage contributors to use AI agents when contributing to TorchJD, but there are a few rules:
- The initiative should come from a human. We do not want PRs from fully automated bots.
- The changes should be reviewed by a human before a non-draft PR is open.
- To avoid vendor lock-in, we do not provide any file that is specific to an agent vendor. To use a specific agent that does not follow open file naming conventions, you have to adapt a few things yourself (e.g. symlink files). For example, to work with claude, you have to symlink `CLAUDE.md` to `AGENTS.md`, and `.claude/skills/` to `skills/`.
- To avoid vendor lock-in, we do not provide any file that is specific to an agent vendor. To use a
specific agent that does not follow open file naming conventions, you have to adapt a few things
yourself (e.g. symlink files). For example, to work with claude, you have to symlink `CLAUDE.md`
to `AGENTS.md`, and `.claude/skills/` to `skills/`.

## Checks

Expand Down
Loading