Skip to content

Latest commit

 

History

History
68 lines (46 loc) · 1.82 KB

contributing.md

File metadata and controls

68 lines (46 loc) · 1.82 KB

Contributor Guide: Adding Resources to Awesome Reflex

Thank you for your interest in contributing to our Awesome List for Reflex! This guide will walk you through the process of adding new resources to our repository.

Steps to Contribute

1. Fork the Repository

2. Clone Your Fork

git clone https://github.com/[Your-Username]/awesome-reflex.git
cd awesome-reflex

3. Create a New Branch

git checkout -b add-new-resource

4. Add Your Resource

  1. Open the README.md file in a text editor.
  2. Find the appropriate section for your resource.
  3. Add your resource using this format:
Resource Name - Brief description of the resource.

Save the file.

5. Commit Your Changes

git add README.md
git commit -m "Add [Resource Name] to [Section Name]"

6. Push Your Changes

git push origin add-new-resource

7. Open a Pull Request

  1. Go to your fork on GitHub.
  2. Click "Compare & pull request" next to your add-new-resource branch.
  3. Ensure the "base repository" is set to reflex-dev/awesome-reflex and "base" is set to main.
  4. Fill in the pull request title and description.
  5. Click "Create pull request."

Guidelines for Adding Resources

  • Ensure the resource is directly related to Reflex.
  • Check that the resource hasn't already been added.
  • Provide a concise, informative description.
  • Place the resource in the appropriate section.
  • Maintain alphabetical order within sections.

Need Help?

If you're new to GitHub or need assistance, don't hesitate to ask for help in the pull request comments or open an issue in the repository.