Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (40 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

49 lines (40 loc) · 1.85 KB
Raw

Contributing to Poly-Maker

First off, thank you for considering contributing to Poly-Maker! Your help is greatly appreciated. Whether it's reporting a bug, suggesting a feature, or writing code, all contributions are welcome.

Code of Conduct

While we don't have a formal Code of Conduct yet, we expect all contributors to treat each other with respect. Please be friendly and considerate.

How Can I Contribute?

Reporting Bugs

If you find a bug, please create an issue and provide the following information:

  • A clear and descriptive title.
  • Steps to reproduce the bug.
  • What you expected to happen.
  • What actually happened.
  • Relevant logs or screenshots.

Suggesting Enhancements

If you have an idea for a new feature or an improvement, create an issue with:

  • A clear and descriptive title.
  • A detailed description of the proposed feature and why it would be useful.
  • Any mockups or examples that might help illustrate your idea.

Submitting Pull Requests

This is the best way to contribute code.

  1. Fork the repository.
  2. Create a new branch for your changes. Use a descriptive name. 
    git checkout -b feature/YourAmazingFeature
  3. Set up your environment. 
    uv sync
  4. Make your changes. Ensure you follow the existing code style.
  5. Test your changes. (If you add new features, please also add tests).
  6. Commit your changes with a clear and concise commit message. 
    git commit -m "feat: Add some AmazingFeature"
  7. Push your branch to your fork. 
    git push origin feature/YourAmazingFeature
  8. Open a Pull Request against the main branch of this repository. Provide a clear description of the problem you are solving and the changes you have made.

Thank you for your contribution!