Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (30 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

46 lines (30 loc) · 1.56 KB
Raw

Contributing to Netresearch Projects

We welcome contributions! Here's how to get started.

Getting Started

  1. Fork the repository
  2. Create a feature branch from main
  3. Make your changes
  4. Submit a pull request

Commit Messages

We use Conventional Commits:

feat: add new feature
fix: resolve bug
docs: update documentation
chore: maintenance task
refactor: code improvement without behavior change
test: add or update tests

Commit Signing

All commits must be cryptographically signed and carry a DCO sign-off: git commit -S --signoff. The require-signed-commits ruleset on the default branch enforces the signature (the "Verified" badge on GitHub); the DCO check enforces the Signed-off-by trailer — these are two different things and both are required. Quickest setup is SSH signing: register your SSH key as a signing key on your GitHub account, then git config --global gpg.format ssh && git config --global user.signingkey ~/.ssh/<key>.pub.

Pull Requests

  • Keep PRs focused — one logical change per PR
  • Update documentation if you change user-facing behavior
  • Ensure CI passes before requesting review
  • Reference related issues (e.g., Closes #42)

Code Review

All PRs are reviewed by automated tools (Copilot, Gemini Code Assist) and maintainers. Please address review comments or explain why you disagree.

Development Setup

Each repository has its own setup instructions in README.md or AGENTS.md. Check those first.

Questions?

Open a discussion or issue in the relevant repository.