Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix internal link in README #250

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

germanfrelo
Copy link

@germanfrelo germanfrelo commented Apr 19, 2024

Hello, and thanks for contributing to micromatch!

tldr

There are three main goals in this document, depending on the nature of your pr:

  • description: please tell us about your pr
  • checklist: please review the checklist that is most closly related to your pr

The following sections provide more detail on each.

Improve this document

Please don't hesitate to ask questions for clarification, or to make suggestions (or a pull request) to improve this document.

Description

To help the project's maintainers and community to quickly understand the nature of your pull request, please create a description that incorporates the following elements:

  • [] what is accomplished by the pr
  • [] if there is something potentially controversial in your pr, please take a moment to tell us about your choices

Checklist

Please use the checklist that is most closely related to your pr (you only need to use one checklist, and you can skip items that aren't applicable or don't make sense):

Fixing typos

  • Please review the readme advice section before submitting changes

Documentation

  • Please review the readme advice section before submitting changes

Bug Fix

  • All existing unit tests are still passing (if applicable)
  • Add new passing unit tests to cover the code introduced by your pr
  • Update the readme (see readme advice)
  • Update or add any necessary API documentation

New Feature

  • If this is a big feature with breaking changes, consider opening an issue to discuss first. This is completely up to you, but please keep in mind that your pr might not be accepted.
  • Run unit tests to ensure all existing tests are still passing
  • Add new passing unit tests to cover the code introduced by your pr
  • Update the readme (see readme advice)

Thanks for contributing!

Readme advice

Please review this section if you are updating readme documentation.

Readme template

This project uses verb for documentation. Verb generates the project's readme documentation from the .verb.md template in the root of this project.

Make all documentation changes in .verb.md, and please do not edit the readme.md directly, or your changes might accidentally get overwritten.

Code comments

Please add code comments (following the same style as existing comments) to describe any code changes or new code introduced by your pull request.

Optionally build the readme

Any changes made .verb.md and/or code comments will be automatically incorporated into the README documentation the next time verb is run.

We can take care of building the documentation for you when we merge in your changes, or feel free to run verb yourself. Whatever you prefer is fine with us.

@germanfrelo germanfrelo marked this pull request as ready for review April 19, 2024 07:20
@germanfrelo germanfrelo changed the title Fix internal link in README docs: fix internal link in README Apr 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant