UNPKG

@idearium/cli/CONTRIBUTING.md

Version:

786 BMarkdownView Raw

1# @idearium/cli
2
3If you'd like to contribute to the cli, you've come to the right spot :)
4
5## Requirements
6
7To get started with development, you'll need:
8
9-   Node.js >v8.0.0
10-   NPM >v4.3.0
11
12## Code
13
14We use `eslint` and `.editorconfig` to keep our code neat and tidy. Make sure you do too.
15
16If you're developing locally and want to test out the cli against an actual project, run `yarn link` from this directory. When you're done, make sure you run `yarn unlink` to ensure you remove the global install.
17
18## Publishing
19
20When you're ready to publish a new version:
21
22-   Version bump the package.json version.
23-   Update the changelog.
24-   Create a new release via the Github UI with the tag `vX.X.X`, branch name as the current branch and the release name the same as the tag `vX.X.X`.

1	`# @idearium/cli`
2
3	`If you'd like to contribute to the cli, you've come to the right spot :)`
4
5	`## Requirements`
6
7	`To get started with development, you'll need:`
8
9	`- Node.js >v8.0.0`
10	`- NPM >v4.3.0`
11
12	`## Code`
13
14	We use `eslint` and `.editorconfig` to keep our code neat and tidy. Make sure you do too.
15
16	If you're developing locally and want to test out the cli against an actual project, run `yarn link` from this directory. When you're done, make sure you run `yarn unlink` to ensure you remove the global install.
17
18	`## Publishing`
19
20	`When you're ready to publish a new version:`
21
22	`- Version bump the package.json version.`
23	`- Update the changelog.`
24	- Create a new release via the Github UI with the tag `vX.X.X`, branch name as the current branch and the release name the same as the tag `vX.X.X`.