You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+32-16Lines changed: 32 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,45 +21,55 @@ Help us keep **semantic-release** open and inclusive. Please read and follow our
21
21
22
22
### Improve documentation
23
23
24
-
As a **semantic-release** user, you are the perfect candidate to help us improve our documentation: typo corrections, clarifications, more examples, new [recipes](docs/recipes/README.md), etc. Take a look at the [documentation issues that need help](https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+user%3Asemantic-release+archived%3Afalse+label%3A%22help+wanted%22+label%3Adocs+).
24
+
As a **semantic-release** user, you are the perfect candidate to help us improve our documentation: typo corrections, clarifications, more examples, new [recipes](docs/recipes), etc. Take a look at the [documentation issues that need help](https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+user%3Asemantic-release+archived%3Afalse+label%3A%22help+wanted%22+label%3Adocs+).
25
25
26
26
Please follow the [Documentation guidelines](#documentation).
27
27
28
28
### Give feedback on issues
29
29
30
-
Some issues are created without information requested in the [Bug report guideline](#bug-report). Help make them easier to resolve by adding any relevant information.
30
+
Some issues are created without information requested in the [Bug report guideline](#bug-report).
31
+
Help make them easier to resolve by adding any relevant information.
31
32
32
-
Issues with the [design label](https://github.com/issues?q=is%3Aopen+is%3Aissue+user%3Asemantic-release+archived%3Afalse+label%3Adesign) are meant to discuss the implementation of new features. Participating in the discussion is a good opportunity to get involved and influence the future direction of **semantic-release**.
33
+
Issues with the [design label](https://github.com/issues?q=is%3Aopen+is%3Aissue+user%3Asemantic-release+archived%3Afalse+label%3Adesign) are meant to discuss the implementation of new features.
34
+
Participating in the discussion is a good opportunity to get involved and influence the future direction of **semantic-release**.
33
35
34
36
### Fix bugs and implement features
35
37
36
-
Confirmed bugs and ready-to-implement features are marked with the [help wanted label](https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+user%3Asemantic-release+archived%3Afalse+label%3A%22help+wanted%22). Post a comment on an issue to indicate you would like to work on it and to request help from the [@semantic-release/maintainers](https://github.com/orgs/semantic-release/teams/contributors) and the community.
38
+
Confirmed bugs and ready-to-implement features are marked with the [help wanted label](https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+user%3Asemantic-release+archived%3Afalse+label%3A%22help+wanted%22).
39
+
Post a comment on an issue to indicate you would like to work on it and to request help from the [@semantic-release/maintainers](https://github.com/orgs/semantic-release/teams/contributors) and the community.
37
40
38
41
## Using the issue tracker
39
42
40
-
The issue tracker is the channel for [bug reports](#bug-report), [features requests](#feature-request) and [submitting pull requests](#submitting-a-pull-request) only. Please use the [Support](docs/support/README.md) and [Get help](README.md#get-help) sections for support, troubleshooting and questions.
43
+
The issue tracker is the channel for [bug reports](#bug-report), [features requests](#feature-request) and [submitting pull requests](#submitting-a-pull-request) only.
44
+
Please use the [Support](docs/support/README.md) and [Get help](README.md#get-help) sections for support, troubleshooting and questions.
41
45
42
46
Before opening an issue or a Pull Request, please use the [GitHub issue search](https://github.com/issues?utf8=%E2%9C%93&q=user%3Asemantic-release) to make sure the bug or feature request hasn't been already reported or fixed.
43
47
44
48
### Bug report
45
49
46
-
A good bug report shouldn't leave others needing to chase you for more information. Please try to be as detailed as possible in your report and fill the information requested in the [Bug report template](https://github.com/semantic-release/semantic-release/issues/new?template=bug-report.md).
50
+
A good bug report shouldn't leave others needing to chase you for more information.
51
+
Please try to be as detailed as possible in your report and fill the information requested in the [bug report template](https://github.com/semantic-release/semantic-release/issues/new?template=01_bug_report.md).
47
52
48
53
### Feature request
49
54
50
-
Feature requests are welcome, but take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible and fill the information requested in the [Feature request template](https://github.com/semantic-release/semantic-release/issues/new?template=feature-request.md).
55
+
Feature requests are welcome, but take a moment to find out whether your idea fits with the scope and aims of the project.
56
+
It's up to you to make a strong case to convince the project's developers of the merits of this feature.
57
+
Please provide as much detail and context as possible and fill the information requested in the [feature request template](https://github.com/semantic-release/semantic-release/issues/new?template=02_feature_request.md).
51
58
52
59
### New plugin request
53
60
54
-
[Plugins](docs/usage/plugins.md) are a great way to extend **semantic-release** capabilities, integrate with other systems and support new project type. Please provide as much detail and context as possible and fill the information requested in the [New plugin request template](https://github.com/semantic-release/semantic-release/issues/new?template=plugin-request.md).
61
+
[Plugins](docs/usage/plugins.md) are a great way to extend **semantic-release** capabilities, integrate with other systems and support new project type.
62
+
Please provide as much detail and context as possible and fill the information requested in the [plugin suggestion template](https://github.com/semantic-release/semantic-release/issues/new?template=03_plugin_suggestion.md).
55
63
56
64
## Submitting a Pull Request
57
65
58
-
Good pull requests, whether patches, improvements, or new features, are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.
66
+
Good pull requests, whether patches, improvements, or new features, are a fantastic help.
67
+
They should remain focused in scope and avoid containing unrelated commits.
59
68
60
-
**Please ask first** before embarking on any significant pull requests (e.g. implementing features, refactoring code), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.
69
+
**Please ask first** before embarking on any significant pull requests (e.g. implementing features, refactoring code), otherwise you risk spending a lot of time working on something that the project's maintainers might not want to merge into the project.
61
70
62
-
If you have never created a pull request before, welcome 🎉 😄. [Here is a great tutorial](https://opensource.guide/how-to-contribute/#opening-a-pull-request) on how to send one :)
71
+
If you have never created a pull request before, welcome 🎉 😄.
72
+
[Here is a great tutorial](https://opensource.guide/how-to-contribute/#opening-a-pull-request) on how to send one :)
- For ambitious tasks, open a Pull Request as soon as possible with the `[WIP]` prefix in the title, in order to get feedback and help from the community.
94
-
-[Allow semantic-release maintainers to make changes to your Pull Request branch](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork). This way, we can rebase it and make some minor changes if necessary. All changes we make will be done in new commit and we'll ask for your approval before merging them.
104
+
-[Allow semantic-release maintainers to make changes to your Pull Request branch](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork).
105
+
This way, we can rebase it and make some minor changes if necessary.
106
+
All changes we make will be done in new commit, and we'll ask for your approval before merging them.
95
107
96
108
## Coding rules
97
109
@@ -140,7 +152,8 @@ A complex feature can be broken down into multiple commits as long as each one m
140
152
141
153
#### Commit message format
142
154
143
-
Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type**, a **scope** and a **subject**:
155
+
Each commit message consists of a **header**, a **body** and a **footer**.
156
+
The header has a special format that includes a **type**, a **scope** and a **subject**:
144
157
145
158
```commit
146
159
<type>(<scope>): <subject>
@@ -156,7 +169,8 @@ The **footer** can contain a [closing reference to an issue](https://help.github
156
169
157
170
#### Revert
158
171
159
-
If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
172
+
If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit.
173
+
In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
160
174
161
175
#### Type
162
176
@@ -191,7 +205,8 @@ The body should include the motivation for the change and contrast this with pre
191
205
192
206
The footer should contain any information about **Breaking Changes** and is also the place to reference GitHub issues that this commit **Closes**.
193
207
194
-
**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
208
+
**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines.
209
+
The rest of the commit message is then used for this.
195
210
196
211
#### Examples
197
212
@@ -232,7 +247,8 @@ $ npm install
232
247
233
248
### Lint
234
249
235
-
All the [semantic-release](https://github.com/semantic-release) repositories use [XO](https://github.com/sindresorhus/xo) for linting and [Prettier](https://prettier.io) for formatting. Prettier formatting will be automatically verified and fixed by XO.
250
+
All the [semantic-release](https://github.com/semantic-release) repositories use [XO](https://github.com/sindresorhus/xo) for linting and [Prettier](https://prettier.io) for formatting.
251
+
Prettier formatting will be automatically verified and fixed by XO.
236
252
237
253
Before pushing your code changes make sure there are no linting errors with `npm run lint`.
Copy file name to clipboardExpand all lines: README.md
+16-17Lines changed: 16 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -50,9 +50,9 @@ This removes the immediate connection between human emotions and version numbers
50
50
- Notify maintainers and users of new releases
51
51
- Use formalized commit message convention to document changes in the codebase
52
52
- Publish on different distribution channels (such as [npm dist-tags](https://docs.npmjs.com/cli/dist-tag)) based on git merges
53
-
- Integrate with your [continuous integration workflow](docs/recipes/README.md#ci-configurations)
53
+
- Integrate with your [continuous integration workflow](docs/recipes/release-workflow/README.md#ci-configurations)
54
54
- Avoid potential errors associated with manual releases
55
-
- Support any [package managers and languages](docs/recipes/README.md#package-managers-and-languages) via [plugins](docs/usage/plugins.md)
55
+
- Support any [package managers and languages](docs/recipes/release-workflow/README.md#package-managers-and-languages) via [plugins](docs/usage/plugins.md)
56
56
- Simple and reusable configuration via [shareable configurations](docs/usage/shareable-configurations.md)
57
57
58
58
## How does it work?
@@ -69,11 +69,11 @@ Tools such as [commitizen](https://github.com/commitizen/cz-cli) or [commitlint]
69
69
70
70
The table below shows which commit message gets you which release type when `semantic-release` runs (using the default configuration):
|`perf(pencil): remove graphiteWidth option`<br><br>`BREAKING CHANGE: The graphiteWidth option has been removed.`<br>`The default graphite width of 10mm is always used for performance reasons.`|~~Major~~ Breaking Release |
|`perf(pencil): remove graphiteWidth option`<br><br>`BREAKING CHANGE: The graphiteWidth option has been removed.`<br>`The default graphite width of 10mm is always used for performance reasons.`|~~Major~~ Breaking Release <br /> (Note that the `BREAKING CHANGE: ` token must be in the footer of the commit) |
77
77
78
78
### Automation with CI
79
79
@@ -87,9 +87,9 @@ For each new commit added to one of the release branches (for example: `master`,
87
87
**semantic-release** offers various ways to control the timing, the content and the audience of published releases.
88
88
See example workflows in the following recipes:
89
89
90
-
-[Using distribution channels](docs/recipes/distribution-channels.md#publishing-on-distribution-channels)
@@ -153,12 +152,12 @@ In order to use **semantic-release** you need:
153
152
154
153
## Badge
155
154
156
-
Let people know that your package is published using **semantic-release** by including this badge in your readme.
155
+
Let people know that your package is published using **semantic-release**and which [commit-convention](#commit-message-format) is followed by including this badge in your readme.
0 commit comments