joepie91/pegjs
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
pegjs/.github/CONTRIBUTING.md

57 lines
2.1 KiB
Markdown
Raw Normal View History

Add a .github directory with contribution guidelines and templates
2016-02-19 16:54:19 +01:00
# Contribution Guidelines
Update CONTRIBUTING.md Improve the text stylistically and grammatically. Rewrite intro to nudge people into the right direction and warn them about the usual fate of spontaneous PRs.
2016-06-21 14:21:57 +02:00
The best way to contribute to PEG.js is by using it and giving back useful
Move guidelines to docs folder
2017-11-29 16:29:42 +01:00
feedback, reporting discovered bugs or requesting missing features.
Add a .github directory with contribution guidelines and templates
2016-02-19 16:54:19 +01:00
Update CONTRIBUTING.md Improve the text stylistically and grammatically. Rewrite intro to nudge people into the right direction and warn them about the usual fate of spontaneous PRs.
2016-06-21 14:21:57 +02:00
You can also contribute code, but be advised that many patches end up being
rejected, usually because the change doesn’t fit the project or because of
various implementation issues. In almost all cases it’s best to get in touch
first before sending a patch.
Add a .github directory with contribution guidelines and templates
2016-02-19 16:54:19 +01:00
## Reporting Bugs
Update CONTRIBUTING.md Improve the text stylistically and grammatically. Rewrite intro to nudge people into the right direction and warn them about the usual fate of spontaneous PRs.
2016-06-21 14:21:57 +02:00
Report bugs using [GitHub issues][issues]. Before submitting a bug report,
please [search existing reports][issues-search-bugs] to see if the bug wasn’t
reported already.
Add a .github directory with contribution guidelines and templates
2016-02-19 16:54:19 +01:00
Update CONTRIBUTING.md Improve the text stylistically and grammatically. Rewrite intro to nudge people into the right direction and warn them about the usual fate of spontaneous PRs.
2016-06-21 14:21:57 +02:00
In the report, please describe:
Add a .github directory with contribution guidelines and templates
2016-02-19 16:54:19 +01:00
Update CONTRIBUTING.md Improve the text stylistically and grammatically. Rewrite intro to nudge people into the right direction and warn them about the usual fate of spontaneous PRs.
2016-06-21 14:21:57 +02:00
* Steps to reproduce the problem
* Expected result(s)
* Actual result(s)
Add a .github directory with contribution guidelines and templates
2016-02-19 16:54:19 +01:00
Update CONTRIBUTING.md Improve the text stylistically and grammatically. Rewrite intro to nudge people into the right direction and warn them about the usual fate of spontaneous PRs.
2016-06-21 14:21:57 +02:00
In most cases, it’s also useful to include a **minimal** example (grammar +
input) reproducing the problem.
Add a .github directory with contribution guidelines and templates
2016-02-19 16:54:19 +01:00
## Requesting Features
Update CONTRIBUTING.md Improve the text stylistically and grammatically. Rewrite intro to nudge people into the right direction and warn them about the usual fate of spontaneous PRs.
2016-06-21 14:21:57 +02:00
Request features using [GitHub issues][issues]. Before submitting a feature
Move guidelines to docs folder
2017-11-29 16:29:42 +01:00
request, please [search existing requests][issues-search-enhancements] to see
if the feature wasn’t requested already.
Add a .github directory with contribution guidelines and templates
2016-02-19 16:54:19 +01:00
Update CONTRIBUTING.md Improve the text stylistically and grammatically. Rewrite intro to nudge people into the right direction and warn them about the usual fate of spontaneous PRs.
2016-06-21 14:21:57 +02:00
In the request, please describe:
Add a .github directory with contribution guidelines and templates
2016-02-19 16:54:19 +01:00
Update CONTRIBUTING.md Improve the text stylistically and grammatically. Rewrite intro to nudge people into the right direction and warn them about the usual fate of spontaneous PRs.
2016-06-21 14:21:57 +02:00
* How the feature should work
* Use case(s) behind it
Add a .github directory with contribution guidelines and templates
2016-02-19 16:54:19 +01:00
## Contributing Code
Update CONTRIBUTING.md Improve the text stylistically and grammatically. Rewrite intro to nudge people into the right direction and warn them about the usual fate of spontaneous PRs.
2016-06-21 14:21:57 +02:00
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*.
Add a .github directory with contribution guidelines and templates
2016-02-19 16:54:19 +01:00
Update CONTRIBUTING.md Improve the text stylistically and grammatically. Rewrite intro to nudge people into the right direction and warn them about the usual fate of spontaneous PRs.
2016-06-21 14:21:57 +02:00
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.
Add a .github directory with contribution guidelines and templates
2016-02-19 16:54:19 +01:00
When appropriate, add documentation and tests.
Use "test" and "tests" instead of "spec" and "specs" This reflects a convention used in most JavaScript projects. The change involves renaming the "spec" directory, Gulp task, etc.
2016-12-08 10:05:17 +01:00
Before submitting, make sure your change passes the tests (`gulp test`) and
Switch from Make to Gulp The core of the transition is getting rid of Makefile and replacing it with gulpfile.js. The rest is details (fixing dependencies, changing all references to "make", etc.). Target/task names mostly stay the same, so in most cases "gulp foo" does what "make foo" did before. The only exceptions are "make browser" and "make browserclean", which are now "gulp browser:build" and "gulp browser:clean" (it feels more systematic). Functionality is mostly unchanged (modulo Gulp clutter in the console), but there are two small exceptions: gulp spec The reporter now displays just dots while previously it displayed spec descriptions. There is also a deprecation warning (most likely because I used an old version of gulp-jasmine in order to support Jasmine 1.x). I kept these issues unfixed because I plan to switch to Mocha soon (#409). gulp browser:build The copyright header is now added manually both to the development and minified build. Before, it was added only to the development build and the minified build relied on preserving it using "uglify --comments". This was broken since switching to //-style comments. There is now also an empty line between the header and the source code. Fixes #444.
2016-10-11 11:33:20 +02:00
ESLint checks (`gulp lint`).
Add a .github directory with contribution guidelines and templates
2016-02-19 16:54:19 +01:00
[issues]: https://github.com/pegjs/pegjs/issues
[issues-search-bugs]: https://github.com/pegjs/pegjs/issues?q=is%3Aopen+is%3Aissue+label%3ABug
[issues-search-enhancements]: https://github.com/pegjs/pegjs/issues?q=is%3Aopen+is%3Aissue+label%3AEnhancement
[pulls]: https://github.com/pegjs/pegjs/pulls
[git-commit-messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
Reference in a new issue Copy permalink