Skip to content

CONTRIBUTING.md

Latest commit

聽

History

History
34 lines (24 loc) 路 1.07 KB

CONTRIBUTING.md

File metadata and controls

34 lines (24 loc) 路 1.07 KB
Raw

Contributing to Cortex

First of all, thank you for being interested in contributing to Cortex! It is people like you that make open-source projects so great.

How to Contribute

Reporting Bugs

If you find a bug, please open an issue and include:

  • Your OS (Windows, Linux, macOS).
  • Steps to reproduce the bug.
  • The error message you got.
  • Screenshots if possible.

Suggesting Features

Have a cool idea for a new agent or feature? Open an Issue and describe it. We will discuss it!

Pull Requests (Code)

If you want to write code for the project:

  1. Fork the repository.
  2. Create your feature branch: git checkout -b feature/AmazingFeature
  3. Commit your changes: git commit -m 'Add some AmazingFeature'
  4. Push to the branch: git push origin feature/AmazingFeature
  5. Open a Pull Request.
  6. Code Style
  7. Write code in English.
  8. Keep the code clean and readable.
  9. Add comments to complex logic.

Need Help?

If you have questions about how to set up the project locally, check the main README.md.