Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
32 lines (20 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

32 lines (20 loc) · 1.64 KB
Raw

Contributing to Swyft

Thanks for your interest in contributing to Swyft! This document explains how to get involved.

Licensing

Swyft is released under the MIT License. By submitting a pull request, issue, or any other contribution to this repository, you agree that your contribution is licensed under the same MIT terms. Please make sure any new package or subproject you add declares "license": "MIT" in its manifest so the licensing stays consistent across the monorepo.

Getting started

  1. Fork the repository and create your branch from main.
  2. Install dependencies for the package you are working on.
  3. Make your change, keeping it focused on a single issue.
  4. Add or update tests where behavior changes.
  5. Open a pull request describing the problem, the fix, and any rollback considerations.

Pull requests

  • Keep changes scoped to the linked issue; avoid unrelated refactors.
  • Reference the issue number in the PR title and description.
  • Ensure CI is green before requesting review.
  • Do not commit secrets, tokens, or credentials.

Reporting issues

Use the issue templates when available and include reproduction steps, expected behavior, and the affected package.

Our issue templates are intentionally lightweight: describe the problem, the expected behavior, and the affected package. You do not need to fill out a formal acceptance-criteria checklist to open an issue — a clear, concise report is enough. If you are reporting a security concern, follow SECURITY.md instead of opening a public issue.

Code of conduct

Be respectful and constructive. Harassment or abusive behavior will not be tolerated.