Skip to content

Latest commit

 

History

History
73 lines (53 loc) · 2.24 KB

CONTRIBUTING.md

File metadata and controls

73 lines (53 loc) · 2.24 KB

Contributing to All-in-Dev

Thank you for considering contributing to the All-in-Dev Open Source Project! Contributions help make this repository a valuable resource for developers worldwide. Whether you're fixing a typo, adding a new tool, or creating a whole new category, your help is appreciated.

How to Contribute

1. Add New Tools or Categories

You can help expand the repository by:

  • Adding a new tool to an existing category.
  • Creating a new category with relevant tools.

Steps:

  1. Fork the repository.
  2. Navigate to the appropriate section or create a new one.
  3. Add the tool with the following format: 
    - **Tool Name**: A brief description of the tool and its main use.
  - [Tool Link](https://example.com)
  4. Submit a pull request with your changes.

2. Improve Existing Documentation

You can contribute by improving the descriptions, adding examples, or fixing typos in the existing documentation.

Steps:

  1. Fork the repository.
  2. Edit the relevant files with your improvements.
  3. Submit a pull request explaining the changes you've made.

3. Submit Bug Reports or Feature Requests

If you encounter an issue or have ideas for new features:

  1. Open an issue in the repository.
  2. Provide as much detail as possible, including:
    • Steps to reproduce bugs.
    • Clear descriptions of your feature request.
    • Relevant examples or use cases.

Guidelines for Contributions

  • Consistency: Follow the existing structure and style of the repository.
  • Relevance: Ensure tools or categories are relevant to the scope of the project.
  • Clarity: Use clear and concise language in documentation.
  • Licensing: Only submit tools that comply with open-source licensing.

Submitting a Pull Request

  1. Fork the repository and create your branch:

    git checkout -b feature/your-feature-name

  2. Make your changes and commit them:

    git commit -m "Add: Description of your changes"

  3. Push your branch to your fork:

    git push origin feature/your-feature-name

  4. Open a pull request with a clear title and description.

Thank you for your contributions! Together, we can make this resource even better for the developer community.