Skip to content

Commit b8410af

Browse files
committed
docs: split off a CONTRIBUTING.md from the README
- condenses the README a bit and uses the standard CONTRIBUTING.md file - it's a file I often look for when filing an issue or creating a PR - leaves the section still in the README so that users (esp. on NPM) will know to go there if they're not aware of that convention - GitHub also now tells users to read the CONTRIBUTING.md of a repo when filing issues or creating PRs, so hopefully this helps point more users in the right direction as well
1 parent 4a69b0d commit b8410af

File tree

2 files changed

+33
-28
lines changed

2 files changed

+33
-28
lines changed

CONTRIBUTING.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Contributing
2+
3+
## Reporting bugs
4+
5+
Report any bugs on github: <https://github.com/ezolenko/rollup-plugin-typescript2/issues>.
6+
7+
Attach your `tsconfig.json`, `package.json` (for versions of dependencies), rollup script and anything else that could influence module resolution, ambient types and typescript compilation.
8+
9+
Check if problem is reproducible after running `npm prune` to clear any rogue types from npm_modules (by default typescript grabs all ambient types).
10+
11+
Check if you get the same problem with `clean` option set to true (might indicate a bug in the cache).
12+
13+
If makes sense, check if running `tsc` directly produces similar results.
14+
15+
Attach plugin output with `verbosity` option set to 3 (this will list all files being transpiled and their imports).
16+
17+
## Developing
18+
19+
Use the normal github process of forking, making a branch and creating a PR when ready. Fix all linting problems (run `npm lint`), fix any failed checks that are run on the PR (basically lint right now). Use an editor that supports editorconfig, or match the settings from `.editorconfig` file manually.
20+
21+
Fastest way to test changes is to do a self build, the plugin is part of its own build system:
22+
- make changes
23+
- run `npm build` (uses last released version on npm)
24+
- check that you get expected changes in `dist`
25+
- run `npm build-self` (uses fresh local build)
26+
- check `dist` for the expected changes
27+
- run `npm build-self` _again_ to make sure plugin built by new version can still build itself
28+
29+
If `build-self` breaks at some point, fix the problem and restart from `build` step (a known good copy).
30+
31+
This repo badly needs unittests and integration tests with various scenarios and expected outcomes though.

README.md

+2-28
Original file line numberDiff line numberDiff line change
@@ -213,32 +213,6 @@ TypeScript `2.4+`
213213
Rollup `1.26.3+`
214214
Node `6.4.0+` (basic es6 support)
215215

216-
### Reporting bugs
216+
### Reporting bugs and Contributing
217217

218-
Report any bugs on github: <https://github.com/ezolenko/rollup-plugin-typescript2/issues>.
219-
220-
Attach your `tsconfig.json`, `package.json` (for versions of dependencies), rollup script and anything else that could influence module resolution, ambient types and typescript compilation.
221-
222-
Check if problem is reproducible after running `npm prune` to clear any rogue types from npm_modules (by default typescript grabs all ambient types).
223-
224-
Check if you get the same problem with `clean` option set to true (might indicate a bug in the cache).
225-
226-
If makes sense, check if running `tsc` directly produces similar results.
227-
228-
Attach plugin output with `verbosity` option set to 3 (this will list all files being transpiled and their imports).
229-
230-
### Contributing
231-
232-
Use the normal github process of forking, making a branch and creating a PR when ready. Fix all linting problems (run `npm lint`), fix any failed checks that are run on the PR (basically lint right now). Use an editor that supports editorconfig, or match the settings from `.editorconfig` file manually.
233-
234-
Fastest way to test changes is to do a self build, the plugin is part of its own build system:
235-
- make changes
236-
- run `npm build` (uses last released version on npm)
237-
- check that you get expected changes in `dist`
238-
- run `npm build-self` (uses fresh local build)
239-
- check `dist` for the expected changes
240-
- run `npm build-self` _again_ to make sure plugin built by new version can still build itself
241-
242-
If `build-self` breaks at some point, fix the problem and restart from `build` step (a known good copy).
243-
244-
This repo badly needs unittests and integration tests with various scenarios and expected outcomes though.
218+
See [CONTRIBUTING.md](./CONTRIBUTING.md)

0 commit comments

Comments
 (0)