Skip to content

Latest commit

 

History

History
76 lines (51 loc) · 2.46 KB

contributing.md

File metadata and controls

76 lines (51 loc) · 2.46 KB
Raw

Contribution Guidelines

Thank you for considering contributing to Awesome Open Source Boilerplates! This document outlines the process and guidelines for contributing.

Code of Conduct

By participating in this project, you agree to abide by our Contributor Code of Conduct. Please read it before contributing.

How to Contribute

  1. Fork the repository
  2. Create a new branch for your contribution
  3. Make your changes
  4. Submit a pull request

Guidelines for Adding a New Boilerplate

Please ensure your submission meets these criteria:

  • Open Source: The boilerplate must have an open source license
  • Active Maintenance: Project should be actively maintained (updated within the last 6 months)
  • Documentation: Must have clear documentation and setup instructions
  • Quality: Should follow best practices and coding standards for its technology
  • Uniqueness: Avoid duplicating existing entries
  • Format: Follow the existing format in the README.md file

Pull Request Format

When submitting a pull request, please:

  • Use the following format for adding entries: 
    - [Project Name](link) - Brief description that explains what makes this boilerplate unique
  • Add new entries to the relevant category
  • Check your spelling and grammar
  • Remove any trailing whitespace
  • Ensure your text editor is set to remove trailing spaces

New Categories

To suggest a new category:

  1. Ensure it's relevant to boilerplates and starter templates
  2. Add it in alphabetical order in the table of contents
  3. Create the corresponding section with a suitable description

Updating Your Pull Request

If the maintainers ask for changes, don't create a new pull request. Instead:

  1. Make the required updates to your existing PR
  2. Push your changes to the same branch
  3. The PR will update automatically

Need help updating your PR? Check out this guide on amending commits.

Quality Checks

Before submitting, verify that your contribution:

  • Links to an active repository
  • Includes a meaningful description
  • Is placed in the correct category
  • Follows the established format
  • Does not duplicate existing entries

Questions?

If you have questions about contributing, feel free to:

  1. Open an issue
  2. Start a discussion
  3. Contact the maintainers

Thank you for helping make Awesome Open Source Boilerplates better! 🎉