Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
92 lines (66 loc) · 2.49 KB

CONTRIBUTING.md

File metadata and controls

92 lines (66 loc) · 2.49 KB
Raw

Contributing to Awesome Astro Integrations

Thank you for your interest in contributing to Awesome Astro Integrations! This document provides guidelines for contributing.

How to Contribute

Adding a New Integration

  1. Check if it's already listed - Search the README to ensure the integration isn't already included
  2. Verify it meets our criteria:
    • ✅ Actively maintained
    • ✅ Well-documented
    • ✅ Production-ready
    • ✅ Performance-conscious
    • ✅ Developer-friendly
  3. Add it to the appropriate section in the README
  4. Include all required information:
    • Name and description
    • Links to documentation, GitHub, and npm
    • Installation instructions
    • Link to code examples (if applicable)
    • Weekly download stats (if available)

Updating Existing Entries

  • Keep information current and accurate
  • Update links if they've changed
  • Refresh download stats periodically
  • Add new code examples if helpful

Improving Examples

  • Add code examples to the appropriate file in the examples/ directory
  • Ensure examples are clear and well-commented
  • Test examples to ensure they work

Reporting Issues

  • Use GitHub Issues to report problems or suggest improvements
  • Be specific about what needs to be changed
  • Include links to relevant resources

Format Guidelines

Integration Entry Format

<details>
<summary><strong>Package Name</strong> - Brief description</summary>

**Weekly Downloads:** ~XK | **Official** (if applicable)

- [📖 Documentation](link)
- [📦 npm](link)
- [💻 GitHub](link)
- [📝 Code Examples](./examples/file.md#section)

**Why it's awesome:** Brief explanation

**Installation:**
```bash
command
```

Code Examples

  • Place code examples in the examples/ directory
  • Organize by category (performance, content, UI frameworks, etc.)
  • Include installation instructions
  • Add comments for clarity

Pull Request Process

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-integration)
  3. Make your changes
  4. Commit your changes (git commit -m 'Add amazing integration')
  5. Push to the branch (git push origin feature/amazing-integration)
  6. Open a Pull Request

Questions?

If you have questions about contributing, feel free to:

Thank you for helping make this resource better for the Astro community! 🚀