Skip to content

📝 Contribute to AI-Code 🚀

Welcome to AI-Code! Whether you're an expert or a beginner, your contributions matter. Let's build AI projects together!

Getting Started

  1. Star & Fork: Star ⭐ & fork the repo.
  2. Clone: 
    git clone https://github.com/<your-github-username>/AI-Code.git && cd AI-Code
  3. Create Branch: 
    git checkout -b <your_branch_name>
  4. Set Up Environment: 
    python -m venv env && source env/bin/activate  # (Windows: env\Scripts\activate)
pip install -r requirements.txt
  5. Preview Locally: 
    mkdocs serve  # Visit http://127.0.0.1:8000/AI-Code/

Making Contributions

  1. Edit Code: Follow project standards.
  2. Stage & Commit: 
    git add . && git commit -m "<your_commit_message>"
  3. Push Changes: 
    git push -u origin <your_branch_name>
  4. Create a Pull Request (PR):
  5. Go to GitHub → Open a PR → Provide clear details.

Contribution Guidelines

  • File Naming: Use kebab-case (e.g., ai-model.py).
  • Docs: Follow README Template.
  • Commits: Keep them concise & meaningful.
  • PRs: No direct commits to main, use PR templates, and include screenshots if relevant.
  • Code Quality: Clean, maintainable & well-commented.

Resources