Contributing ============ .. _contributing: We love your input! We want to make contributing to **Curaitor Agent** as easy and transparent as possible. Contributions can include: - Reporting a bug - Proposing new features - Submitting new code - Writing documentation Reporting Bugs -------------- .. _reporting-bugs: To report bugs, please open an issue on GitHub and clearly state: - The observed (buggy) behavior (screenshots are encouraged) - The desired behavior - Your operating system and Python version - Any additional information that might help us fix the bug If possible, provide a **minimum example** that reproduces the bug. Fixing Bugs ----------- .. _fixing-bugs: Look through the GitHub issues for bugs. Anything tagged with **bug** and **help wanted** is open to anyone who wants to implement it. Implement Features ------------------ .. _implement-features: Look through the GitHub issues for features. Anything tagged with **enhancement** and **help wanted** is open to contributors. Write Documentation ------------------- .. _write-documentation: Documentation is always welcome! Contributions can include: - Adding content to the official **Curaitor Agent** docs - Improving docstrings in the code - Writing tutorials, blog posts, or articles Requesting Features ------------------- .. _requesting-features: We welcome suggestions for how to make this project better! To submit ideas, open an issue on GitHub and: - Explain in detail how the feature would work - Keep the scope narrow to make it easier to implement Submit Feedback --------------- .. _submit-feedback: The best way to send feedback is to file an issue at: `https://github.com/ritesh001/curaitor-agent/issues `_ Pull Request Guidelines ----------------------- .. _pull-request-guidelines: Before submitting a pull request, please ensure: - The pull request includes tests if applicable - If it adds functionality, the documentation is updated - The code passes existing tests and follows project coding standards Remember, this is a volunteer-driven project, and **all contributions are welcome**!