Skip to content

Commit

Permalink
Code review issues
Browse files Browse the repository at this point in the history
  • Loading branch information
hildjj committed Feb 12, 2024
1 parent be68953 commit 534b19b
Show file tree
Hide file tree
Showing 5 changed files with 3,446 additions and 14 deletions.
22 changes: 14 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,8 @@ npm run build
npm run test:web
```

If you send a pull request, please update the `CHANGELOG.md` file, and ensure
that your information is in the `AUTHORS` file is correct -- even for minor
changes. If you change anything in the `src` or `lib` directories, make sure
you have run a test, and include the minimized versions in the docs directory
in your commit.
Please see the [Contribution Guidelines](CONTRIBUTING.md) for details on how
to contribute code.

## Links

Expand All @@ -72,6 +69,7 @@ in your commit.
- [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/)
Expand Down
2 changes: 1 addition & 1 deletion docs/js/test-bundle.min.js

Large diffs are not rendered by default.

Loading

0 comments on commit 534b19b

Please sign in to comment.