Skip to content
This repository was archived by the owner on Aug 1, 2021. It is now read-only.

Commit 41d3761

Browse files
Merge pull request #183 from technote-space/feature/update_docs
chore: update docs
2 parents 74278be + cf84236 commit 41d3761

File tree

1 file changed

+9
-12
lines changed

1 file changed

+9
-12
lines changed

.github/CONTRIBUTING.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
11
# Contributing
2-
3-
[issues]: /issues
4-
[fork]: /fork
5-
[pr]: /compare
6-
[js-style]: https://standardjs.com/
2+
[issues]: https://github.com/technote-space/marker-animation/issues
3+
[fork]: https://github.com/technote-space/marker-animation/fork
4+
[pr]: https://github.com/technote-space/marker-animation/compare
75
[eslint]: https://eslint.org/
86
[jest]: https://jestjs.io/
9-
[mocha]: https://mochajs.org/
107
[phpcs]: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Usage
118
[phpmd]: https://phpmd.org/documentation/index.html
129
[wp-test]: https://developer.wordpress.org/cli/commands/scaffold/plugin-tests/
@@ -23,23 +20,23 @@ Please note we have a [Contributor Code of Conduct][code-of-conduct], please fol
2320
- `composer setup` # install and build
2421
- `composer bin:download` # download test scripts
2522
- `composer bin:prepare` # prepare test settings and download dependent plugins
26-
1. Make sure the tests pass on your machine: `composer bin:test-p`, which contains
23+
1. Make sure the tests pass on your machine: `composer bin:test`, which contains
2724
- [`PHPCS`][phpcs]
2825
- [`PHPMD`][phpmd]
2926
- [`WordPress Plugin Tests`][wp-test]
3027
- [`ESLint`][eslint]
31-
- [`Jest`][jest] or [`Mocha`][mocha]
28+
- [`Jest`][jest]
3229
- `Build test`
3330
1. Create a new branch: `git checkout -b my-branch-name`
3431
1. Make your change, add tests, and make sure the tests still pass.
3532
1. Push to your fork and [submit a pull request][pr].
3633
1. Pat your self on the back and wait for your pull request to be reviewed and merged.
3734

3835
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
39-
- Follow the style guides ([JavaScript Standard Style][js-style], [PHPCS][phpcs], [PHPMD][phpmd]). Any linting errors should be shown when running
40-
- `composer bin:js-lint`
41-
- `composer bin:phpcs`
42-
- `composer bin:phpmd`
36+
- Follow the style guides. Any linting errors should be shown when running
37+
- `composer bin:js-lint` # [`ESLint`][eslint]
38+
- `composer bin:phpcs` # [`PHPCS`][phpcs]
39+
- `composer bin:phpmd` # [`PHPMD`][phpmd]
4340
- Write and update tests.
4441
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
4542
- Write a [good commit message](https://github.com/erlang/otp/wiki/writing-good-commit-messages).

0 commit comments

Comments
 (0)