Skip to content

Latest commit

 

History

History
40 lines (28 loc) · 1.96 KB

CONTRIBUTING.md

File metadata and controls

40 lines (28 loc) · 1.96 KB

Contributing Guidelines

Thank you for your interest in contributing to our project! To ensure a smooth and efficient process, please follow these guidelines when submitting your pull request:

  1. Check Existing Pull Requests:

    • Before creating a new pull request, search through the existing ones to avoid duplicates.

  2. Use Proper Format:

    • Follow this format for adding resources: 
      | Name | Description | Homepage | License |
|--------------------------|------------------------------------------------------------|--------------------------------------------|------------|
| [Example](https://example.com) | An example resource description.                          | [Homepage](https://example.com)            | MIT        |

  3. Explain the Resource:

    • Provide a brief explanation of why the resource is useful in your pull request if necessary.

  4. Resource Age:

    • Ensure that any added projects are at least 30 days old.

  5. Keep Descriptions Concise:

    • Keep descriptions short and simple but still informative.

  6. Enhance Categories:

    • Feel free to add new categories or improve existing ones.

  7. Proofread:

    • Double-check your spelling and grammar!

  8. Follow the Upstream Guidelines:

  9. Use Awesome Lint:

    • To ensure your submission meets basic formatting standards, you can use the awesome-lint GitHub Action. If possible, run it locally before submitting.

  10. Submit with a Pull Request:

    • When you're ready, submit your contribution as a pull request. Provide a clear and concise description of the changes made and the reasons for the addition.

Thank you for contributing!