Welcome to the AI Toolkit contributing guide! If you're interested in contributing to the AI Toolkit project, this document will help you get started.
Contributing Process
- Fork the Repository: [Fork the AI Toolkit repository](Fork AI Toolkit) on GitHub.
- Create a Feature Branch: Create a new branch for your feature or fix.
- Implement Your Changes: Make the necessary changes in your feature branch.
- Commit and Push: Commit your changes and push the branch to your fork.
- Open a Pull Request: Open a pull request from your feature branch to the main branch of the original repository.
Coding Standards
- Follow the [coding standards](AI Toolkit Coding Standards) to ensure consistency across the project.
- Use PEP 8 for Python code and PEP 257 for docstrings.
Testing
- Write unit tests for your code to ensure functionality.
- Use pytest for testing.
Documentation
- Write clear and concise documentation for your contributions.
- Update the [README](AI Toolkit README) and other relevant documentation.
Common Issues
- Bug Reports: [Report bugs here](AI Toolkit Bug Reports).
- Feature Requests: [Request features here](AI Toolkit Feature Requests).
AI_Toolkit