Skip to content
This repository was archived by the owner on Apr 29, 2024. It is now read-only.

Commit cf5b0e1

Browse files
committed
Create CONTRIBUTING.md
1 parent b58cc8f commit cf5b0e1

File tree

1 file changed

+78
-0
lines changed

1 file changed

+78
-0
lines changed

CONTRIBUTING.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Contributing
2+
3+
## System Dependencies
4+
5+
### Node
6+
7+
* [Node.js](https://nodejs.org/) - v12.0.0+
8+
* [npm](https://www.npmjs.com/) - v6.0.0+
9+
10+
## Install project dependencies
11+
12+
### Code
13+
14+
* Fork and clone the sentry-release-deploy-action repo
15+
16+
### Install project dependencies
17+
18+
`npm install`
19+
20+
This installs dependencies from `package.json`.
21+
22+
## npm scripts
23+
24+
`npm run lint`
25+
26+
This will:
27+
28+
* run linters
29+
30+
`npm test`
31+
32+
This will:
33+
34+
* run all of the jest tests
35+
36+
`npm build`
37+
38+
This will:
39+
40+
* uses ncc to compile a single module with all necessary dependencies
41+
42+
## Code guidelines
43+
44+
### JS
45+
46+
sentry-release-deploy-action utilizes ESLint to enforce JavaScript standards. Please see the `.eslintrc.json` file for ESLint config.
47+
48+
* [eslint](https://github.com/eslint/eslint)
49+
50+
#### Checking coding style
51+
52+
Run `npm run lint` before committing to ensure your changes follow our coding standards.
53+
54+
## Versioning
55+
56+
Please use the following commands to increment the package's version numbers
57+
Ex: Assume current version is 0.0.1
58+
59+
`npm version patch --no-git-tag-version`
60+
61+
If you run this command the version will increase the patch number (ie 0.0.2)
62+
63+
`npm version minor --no-git-tag-version`
64+
65+
If you run this command the version will increase the minor number (ie 0.1.0)
66+
67+
`npm version major --no-git-tag-version`
68+
69+
If you run this command the version will increase the major number (ie 1.0.0)
70+
71+
72+
## EditorConfig
73+
74+
EditorConfig helps maintain consistent file formatting between different editors and developers. Please [install the plugin for you editor of choice](https://editorconfig.org/#download). Please see the `.editorconfig` file at the root of this repo to see what settings are enforced.
75+
76+
## License
77+
78+
Contributions to sentry-release-deploy-action are subject to the [MIT License](https://github.com/tclindner/sentry-release-deploy-action/blob/master/LICENSE).

0 commit comments

Comments
 (0)