Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
36 lines (24 loc) · 1.11 KB

CONTRIBUTING.md

File metadata and controls

36 lines (24 loc) · 1.11 KB
Raw

Contributing to Cortex

We love your input! We want to make contributing to Cortex as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

Quick Contribution Guide

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'feat: add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Development Workflow

  • Follow Rust best practices and project conventions.
  • Ensure all tests pass: just test.
  • Run just ci-local before submitting a PR.
  • Update documentation as needed.

Code of Conduct

This project follows the Rust Code of Conduct.

Reporting Bugs

We use GitHub issues to track public bugs. Report a bug by opening a new issue.

License

By contributing to Cortex, you agree that your contributions will be licensed under the Cortex MIT License.