Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (42 loc) · 2.17 KB

CONTRIBUTING.md

File metadata and controls

65 lines (42 loc) · 2.17 KB

Contributing to Awesome-React 🤝

Thank you for your interest in contributing to Awesome-React! We welcome contributions from everyone in the community.

📋 How to Contribute

  1. Fork the repository.
  2. Create a new branch for your changes: git checkout -b add/your-resource-name
  3. Make your changes following the guidelines below.
  4. Commit your changes: git commit -m "Add [resource name]"
  5. Push to your fork: git push origin add/your-resource-name
  6. Open a Pull Request against the main branch.

✅ Contribution Guidelines

Adding a New Resource

  • Add your resource to the most relevant section of Readme.md.
  • Use the following format: 
    - [Resource Name](https://link-to-resource) – Short description of what it does.
  • The description should be concise (one sentence) and start with a capital letter.
  • Make sure the link is working and publicly accessible.
  • Avoid duplicate entries — check the list first.

Proposing a New Section

  • If your resource doesn't fit any existing section, open an issue first to discuss adding a new section.
  • New sections must have at least 3 resources to be included.

Removing or Updating Resources

  • If a resource is outdated, unmaintained, or the link is broken, please open an issue or a PR with the fix.

🚫 What Not to Submit

  • Paid or closed-source tools without a meaningful free tier.
  • Personal projects without significant community adoption.
  • Resources unrelated to React or its ecosystem.
  • Duplicate entries already listed.

💡 Tips

  • Keep pull requests small and focused — one resource or fix per PR is ideal.
  • Write a clear PR description explaining what you're adding and why it belongs.
  • Be respectful and constructive in all interactions. See our Code of Conduct.

Code of Conduct

By participating in this project, you agree to be respectful and inclusive. We follow the Contributor Covenant code of conduct. Please read CODE_OF_CONDUCT.md for details.

Thank you for helping make Awesome-React even more awesome! 🌟