Skip to content

Latest commit

 

History

History
50 lines (41 loc) · 1.3 KB

CONTRIBUTING.md

File metadata and controls

50 lines (41 loc) · 1.3 KB

🤝 Contributing to AI Models & Tools Compendium

How to Contribute

Adding New Models

  1. Fork the repository
  2. Create a new branch (git checkout -b add-model-name)
  3. Add your model following the existing format: 
    X. 🆕 Model Name (Organization)
   • License: [Type]
   • Repository: [URL]
   • Parameters: [if applicable]
   • Notes: [Key features]
  4. Update the Table of Contents
  5. Submit a Pull Request

Updating Existing Models

  1. Fork the repository
  2. Create a new branch (git checkout -b update-model-name)
  3. Update the relevant information
  4. Add a changelog entry
  5. Submit a Pull Request

Format Requirements

  • Include all required fields (License, Repository, Notes)
  • Add appropriate emojis
  • Maintain alphabetical order within categories
  • Verify license information
  • Test all links

Before Submitting

  • Verified model information
  • Added/updated Table of Contents
  • Checked formatting
  • Added changelog entry
  • Tested all links

Review Process

  1. Maintainers will review your PR
  2. Address any requested changes
  3. Once approved, changes will be merged
  4. Changelog will be updated

Questions?

Open an issue for any questions about contributing.

Thank you for helping improve the AI Models & Tools Compendium! 🙏