Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
87 lines (59 loc) · 3.57 KB

CONTRIBUTING.md

File metadata and controls

87 lines (59 loc) · 3.57 KB
Raw

Contributing

Thank you for your interest in Rayfin. We welcome thoughtful contributions from both individual developers and AI-assisted workflows.

Contributor License Agreement

Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit Contributor License Agreements portal.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA.

Code of Conduct

This project follows the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

How to Contribute

Reporting Bugs

Use the Bug Report issue template. Include reproduction steps, environment details, and any relevant logs or screenshots.

Requesting Features

Use the Feature Request issue template. Describe your use case and the expected behavior.

Submitting Pull Requests

  1. Fork the repository and create a branch for your change.
  2. Keep pull requests scoped to a focused set of changes.
  3. Include a clear description of the change and its rationale.
  4. Run any existing linters, builds, and tests before submitting.

Commit Messages

This repo uses Conventional Commits.

Format: <type>(<scope>): <description>

Type When to use
feat New feature or capability
fix Bug fix
docs Documentation changes
chore CI, scripts, infrastructure
refactor Code restructuring without behavior change

Examples:

feat: add support for custom entity validators
fix: correct auth token refresh on expiry
docs: update getting started guide
chore(ci): add Node 22 to test matrix

AI-Assisted Contributions

We encourage transparent use of AI agents, copilots, and other tools that accelerate high-quality contributions. If AI helped you create the contribution, disclose the tools used and how they influenced the work in your pull request or issue summary.

When submitting AI-assisted changes, make sure that you:

  • Test the changes yourself and share the results or reproduction steps.
  • Understand the code you are contributing so that you can answer follow-up questions.
  • Explain why the change is needed and how it improves Rayfin.
  • Provide evidence such as screenshots, logs, or test output when fixes or features require verification.

We may close contributions that:

  • Appear to be untested or copy-pasted without human review.
  • Offer generic suggestions that do not address specific Rayfin needs.
  • Consist of bulk submissions with no clear analysis or rationale.

Repeated submissions that ignore these guidelines may lead to additional review requirements or contribution limits. Respect the maintainers' time and keep communication clear, direct, and professional.

Resources