From 4e265b6bd78b0dce09f47d6b4052442eff23a49c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=86=8D=E4=BC=9A?= <150756597+Annyfee@users.noreply.github.com> Date: Sun, 26 Oct 2025 09:37:50 +0800 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..17bb3df --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,33 @@ +# 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! 💡