Skip to content

Latest commit

 

History

History
103 lines (87 loc) · 5.29 KB

CONTRIBUTING.md

File metadata and controls

103 lines (87 loc) · 5.29 KB
Raw

Contribution Guidelines for the "Awesome Research Tools" Repository

Thank you for contributing to the Awesome Research Tools repository! I want to make accessing fine resource across the internet much easier and navigating across other awesome tools out there!

I want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

Table of Contents

Contribution Procedure

We Use Github Flow, So All Code Changes Happen Through Pull Requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

  1. Fork the repo and create a new branch in your forked repo from main.
  2. Add the resource to the appropriate section in the README.md file.
  3. Commit your changes and push your new branch to your forked repo.
  4. Issue a pull request!
  5. Verify that all CI checks have passed (we use pre-commit.ci) and the PR has been reviewed and approved by at least one maintainer.

How do I contribute?

The project adheres to certain content-formatting and quality standards for consistent Markdown style. Please read the following guidelines below before committing and submitting a pull request (PR):

  1. Resource Format:

    • Each resource should be added in the following format: 
      - [**Resource Name**](Resource URL) - *Short Description*
    • Replace Resource Name with the actual name of the tool and Resource URL with the link to the tool.
    • Provide a brief Short Description highlighting the tool's purpose or key features.

  2. Non-URL Resources:

    • If the resource is a file, create a new folder assets (if it doesn't exist) in the same directory level.
    • Add the file inside the assets folder
    • Use the following format in the appropriate section of the README.md file: 
      - [**Resource Name**](assets/name_of_the_file) - *Short Description*
    • Replace Resource Name with the actual name of the tool.
    • Replace name_of_the_file with the name of the file you added in the assets folder.
    • Provide a brief Short Description highlighting the tool's purpose or key features.

  3. Validity Criteria:

    • The resource must be either free or offer a freemium service (with essential features available for free).
    • Avoid redundant resources that are already listed in the repository.
    • Don't add illegitimate or spammy resources with links to malicious websites.

  4. Table of Contents:

    • If you are adding a new category, ensure that it is relevant to the repository and use the following format: 
      ## Category Name
    • For subcategories, use the following format: 
      ### Sub-Category Name
    • The main README.md file should have a clear table of contents pointing (TOC) to your newly added section with nested bullet points.
    • Organize resources under relevant categories (e.g., "Literature Search," "Data Analysis," "Machine Learning," etc.).

  5. Quality Check:

    • Before submitting a new resource, ensure that it adds value to the repository.
    • Verify the credibility and usefulness of the tool.
    • Consider whether the tool is widely used or has positive reviews.

  6. Contributing Steps:

    • Fork the repository to your GitHub account.
    • Create a new branch for your contribution.
    • Add the resource to the appropriate section in the README.md file.
    • Commit your changes and create a pull request (PR).

  7. PR Review Process:

    • The maintainers will review your PR.
    • If the resource meets the criteria, it will be merged into the repository.
    • If necessary, the maintainers may request additional information or changes.

  8. Be Courteous:

    • Be respectful and considerate in your interactions with other contributors.
    • Encourage open discussions and collaboration.

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Remember, this repository thrives on community contributions, so thank you for helping make it a valuable resource for everyone! 💻