Skip to content

Commit

Permalink
Extend contributing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
JuliaCasamitjana committed Apr 26, 2023
1 parent 82d5ba2 commit e48427b
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,26 @@ In the description, illustrate first what your code will change.
Please add a section on decisions and choices you made next.
This is very useful for reviewers to quickly get an overview and understand what the PR is about.

If you expect your pull request to be released in a new version after being merged, you should include
a commit in your PR with the `package.json` and `package-lock.json` update.

To define the release type and number, please refer to the [semantic versioning](https://docs.npmjs.com/about-semantic-versioning)
documentation.

### Release notes

When creating the release notes from a package release, you may use the "Generate release notes" button.
This will automatically generate a list of all merged PRs with their contributors and a link to the corresponding commit.

Add the label `[Feature]`, `[Maintenance]`, `[Bugfix]` or `[Task]` in front of each generated bullet point and, if applicable,
the corresponding ticket number. Example:

```
- [Feature] Extend public API with current progress (XI-5191) by @developer_1 in #69
- [Bugfix] Double click on any player element triggered full screen by @developer_2 in d564cdf
- [Maintenance] Update dependency @types/vimeo__player to v2.18.0 by @renovate in #66
```

### Code Style

We follow the [proposed guideline by Stencil](https://stenciljs.com/docs/style-guide#code-organization).
Expand Down

0 comments on commit e48427b

Please sign in to comment.