Merge pull request peggyjs#469 from hildjj/fix-466

Add developer docs.

CHANGELOG.md

@@ -64,6 +64,7 @@ Released: TBD
 
 - [#405](https://github.com/peggyjs/peggy/pull/405) Doc example doesn't correspond to code example.  From @hildjj
 - [#415](https://github.com/peggyjs/peggy/issues/415) Make docs match reality with `import`.
+- [#466](https://github.com/peggyjs/peggy/issues/466) Add docs for developers.
 
 3.0.2
 -----

CONTRIBUTING.md

@@ -36,20 +36,26 @@ In the request, please describe:
 
 ## Contributing Code
 
-Contribute code using [GitHub pull requests][pulls]. For non-trivial changes,
-first file a corresponding bug report or feature request. This will ensure the
-*problem* is separated from a *solution*.
+Contribute code using [GitHub pull requests][pulls].
 
-Split your change into atomic commits with descriptive messages adhering to
+1. For non-trivial changes, first file a corresponding bug report or feature
+request. This will ensure the *problem* is separated from a *solution*.
+
+1. Split your change into atomic commits with descriptive messages adhering to
 [these conventions][git-commit-messages]. Have a look in the commit history to
 see good examples.
 
-When appropriate, add documentation and tests.
+1. When appropriate, add documentation and tests.
+
+1. Before submitting, make sure your change passes the tests and lint checks
+by running `npm run build`.  If the build script produces output that git sees
+as a change, please add that output file to your pull request.
 
-Before submitting, make sure your change passes the tests (`npm test`) and
-ESLint checks (`npm run lint`).
+1. Ensure that your pull request contains an addition to the
+[CHANGELOG.md](CHANGELOG.md) file.
 
-Please add yourself to the AUTHORS file.
+1. Please add yourself to the [AUTHORS](AUTHORS) file, or double-check that the
+information there is still correct if you have contributed before.
 
 [issues]: https://github.com/peggyjs/peggy/issues
 [issues-search-bugs]: https://github.com/peggyjs/peggy/issues?q=is%3Aopen+is%3Aissue+label%3ABug

README.md

@@ -45,13 +45,31 @@ Full documentation is available at [peggyjs.org](https://peggyjs.org/documentati
 
 ## Development
 
+To get started, check out peggy, install the dependencies, and run build:
+
+```bash
+git clone https://github.com/peggyjs/peggy.git
+cd peggy
+npm install
+(cd docs && npm install)
+(cd web-test && npm install)
+npm run build
+npm run test:web
+```
+
+Please see the [Contribution Guidelines](CONTRIBUTING.md) for details on how
+to contribute code.
+
+## Links
+
 - [Project website](https://peggyjs.org/)
 - [Wiki](https://github.com/peggyjs/peggy/wiki)
 - [Source code](https://github.com/peggyjs/peggy)
 - [Issue tracker](https://github.com/peggyjs/peggy/issues)
 - [Discussions](https://github.com/peggyjs/peggy/discussions)
 - [Browser Benchmark Suite](https://peggyjs.org/development/benchmark.html)
 - [Browser Test Suite](https://peggyjs.org/development/test.html)
+- [Contribution Guidelines](CONTRIBUTING.md)
 - [Discord Server](https://discord.gg/HU5tbEbwAB)
 
 Peggy was originally developed by [David Majda](https://majda.cz/)