Skip to content

Commit

Permalink
[docs] Fix some link issues in contributing docs (#4212)
Browse files Browse the repository at this point in the history
* fix toc links not working

* fix more missing hash
  • Loading branch information
Brianzchen committed Dec 29, 2021
1 parent a0b19d4 commit d678d08
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions CONTRIBUTING.md
Expand Up @@ -6,12 +6,12 @@ Contributing library definitions is as easy as sending a pull request!

* [Understanding the definitions structure](#understanding-the-definitions-structure)
* [Making a contribution](#making-a-contribution)
* [Create package directory](1-create-a-new-directory-called-definitionsnpmleft-pad_v4xx)
* [Create flow directory](2-in-this-new-directory-create-another-new-directory-called-flow_v083x-)
* [Create definition](3-place-your-libdef-inside-the-flow-version-directory-and-name-it-left-pad_v4xxjs)
* [Create tests](4-write-a-test-file-whose-name-starts-with-test_-in-the-flow-version-directory)
* [Run tests](5-run-your-tests)
* [Raise pull request](6-send-a-pull-request)
* [Create package directory](#1-create-a-new-directory-called-definitionsnpmleft-pad_v4xx)
* [Create flow directory](#2-in-this-new-directory-create-another-new-directory-called-flow_v083x-)
* [Create definition](#3-place-your-libdef-inside-the-flow-version-directory-and-name-it-left-pad_v4xxjs)
* [Create tests](#4-write-a-test-file-whose-name-starts-with-test_-in-the-flow-version-directory)
* [Run tests](#5-run-your-tests)
* [Raise pull request](#6-send-a-pull-request)
* [Writing libdefs best practices](#writing-libdefs-best-practices)
* [Read flow docs](#read-flow-docs)
* [Don't import types from other libdefs](#dont-import-types-from-other-libdefs)
Expand All @@ -20,8 +20,8 @@ Contributing library definitions is as easy as sending a pull request!
* [Avoid global types](#avoid-global-types)
* [Prefer immutability](#prefer-immutability)
* [Prefer exactness](#prefer-exactness)
* [Partial/definitions definitions](partialdefinitions-definitions)
* [A note on flowgen](a-note-on-flowgen)
* [Partial/definitions definitions](#partialdefinitions-definitions)
* [A note on flowgen](#a-note-on-flowgen)
* [Writing tests](#writing-tests)
* [Use `describe` and `it` blocks to limit scope](#use-describe-and-it-blocks-to-limit-scope)

Expand Down Expand Up @@ -164,11 +164,11 @@ the test-runner for *all* versions of flow the package version supports. Though
# If you want to run something very specific,
# taking the left-pad example you can point to the
# local cli script and run tests against it
node dist/cli.js run-tests left-pad
node cli/dist/cli.js run-tests left-pad

# Running the local cli without any args will run `all`
# tests which may take a while
node dist/cli.js run-tests
node cli/dist/cli.js run-tests
```

> Windows instructions TBD if someone wants to help :construction_worker:
Expand Down

0 comments on commit d678d08

Please sign in to comment.