Skip to content

Add contributing note about git submodules #13

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.

Sign up for GitHub

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

Open
jkup wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add contributing note about git submodules #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,15 @@ npx [todo-name-tool] --sourceMap sourcemap.js.map --generatedFile generated.js -

## How the Project Works

### Contributing

1. Clone the repo
1. Run `npm install`
1. Run `git submodule init`
1. Run `git submodule update`

From there, you can run tests with `npm test` or make a build with `npm run build`.

### Validators

The project uses a series of validators to check the integrity of source maps:
Expand Down