Contributing to AI Pocket Reference Code

This guide explains how to contribute supplementary notebooks to the AI Pocket Reference project.

Notebook Guidelines

Naming Convention
- Name your notebook to match its corresponding pocket reference
- Example: If contributing code for the LoRA pocket reference, name it lora.ipynb
Directory Structure
- Place notebooks in the same book directory as their corresponding pocket reference
- Example: If the pocket reference is in the CV book, the notebook goes in notebooks/cv/
Notebook Structure
- Clear introduction explaining the purpose
- Install required dependencies using %pip install <python-dep> commands at the start
Code Quality
- Write clean, documented code
- Ensure all code cells run in sequence

Fork the Repository

# Clone your fork
git clone https://github.com/YOUR_USERNAME/ai-pocket-reference-code.git
cd ai-pocket-reference-code

Install pre-commit
```
# Install and set up pre-commit hooks
pip install pre-commit
pre-commit install
```
The pre-commit hooks help maintain consistent code quality across the contributed notebooks. These checks run automatically before each commit. Alternatively, run make lint and ensure all checks pass prior to submitting a Pull Request.
Create a Pull Request
- Create a new branch for your notebook
- Add your notebook to the appropriate directory
- Submit a pull request and fill in the PR template

By contributing, you agree that your work will be licensed under the MIT License.

For questions or support, join our Discord community (#ai-pocket-reference channel).

Thank you for helping make AI knowledge more applicable to everyone!