Skip to content

Commit

Permalink
contributing requirements now just need a corresponding issue...
Browse files Browse the repository at this point in the history
on GitHub board
  • Loading branch information
diasbruno committed Feb 12, 2024
1 parent 449398d commit 588f26b
Showing 1 changed file with 4 additions and 25 deletions.
29 changes: 4 additions & 25 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,10 @@
### Commit Subjects

If your patch **changes the API or fixes a bug** please use one of the
following prefixes in your commit subject:
Patches will be only accepted if they have a corresponding issue
on GitHub.

- `[fixed] ...`
- `[changed] ...`
- `[added] ...`
- `[removed] ...`

That ensures the subject line of your commit makes it into the
auto-generated changelog. Do not use these tags if your change doesn't
fix a bug and doesn't change the public API.

Commits with changed, added, or removed, must be reviewed by another
collaborator.

#### When using `[changed]` or `[removed]`...

Please include an upgrade path with example code in the commit message.
If it doesn't make sense to do this, then it doesn't make sense to use
`[changed]` or `[removed]` :)
Having a corresponding issue is better to track
and discuss ideas and propose changes.

### Docs

Expand All @@ -33,12 +18,6 @@ always be in sync.
- `scripts/test` same as `npm test` but keeps karma running and watches
for changes

### Build

Please do not include the output of `scripts/build` in your commits, we
only do this when we release. (Also, you probably don't need to build
anyway unless you are fixing something around our global build.)

## Miscellaneous

if you faced the below issue, make sure you use node version < 18
Expand Down

0 comments on commit 588f26b

Please sign in to comment.