34 lines
1.2 KiB
Markdown
34 lines
1.2 KiB
Markdown
# Contributing to Agent Craft
|
|
|
|
Thank you for your interest in contributing to **Agent Craft**! 🎉
|
|
|
|
This repository is an open-source learning platform for building AI Agents. Your contributions are welcome and appreciated.
|
|
|
|
## How to Contribute
|
|
|
|
### 1. Reporting Issues
|
|
- Please submit any bugs, errors, or improvement suggestions via the [Issues](https://github.com/Annyfee/agent-craft/issues) page.
|
|
- Use clear titles and provide steps to reproduce the issue if applicable.
|
|
- Include screenshots or code snippets if helpful.
|
|
|
|
### 2. Pull Requests (PRs)
|
|
- Fork the repository and create a new branch for your changes.
|
|
- Make your changes with clear commit messages.
|
|
- Submit a PR to the main branch.
|
|
- Example contributions:
|
|
- Fix typos or improve documentation
|
|
- Add code examples or minor improvements to modules
|
|
- Suggest enhancements for existing tutorials
|
|
|
|
### 3. Coding Style
|
|
- Follow Python best practices.
|
|
- Keep code clear and easy to read.
|
|
- Include comments to explain logic if needed.
|
|
|
|
### 4. Guidelines
|
|
- Be respectful and constructive in all interactions.
|
|
- Avoid including any sensitive or private data in your contributions.
|
|
- Ensure any code or examples adhere to licensing and legal compliance.
|
|
|
|
Thank you for helping make **Agent Craft** better! 💡
|