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! 💡 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..caea664 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2025 Annyfee + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE.