Skip to content

Commit

Permalink
add new changelog folder
Browse files Browse the repository at this point in the history
  • Loading branch information
goapunk authored and Rineee committed Jul 4, 2023
1 parent 30a0748 commit 2ec3367
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 0 deletions.
3 changes: 3 additions & 0 deletions changelog/0001.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
### Added

- add a changelog folder and readme with guideline for new changelog system
42 changes: 42 additions & 0 deletions changelog/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
### Changelogs

Temporary folder to add new changes. Each change should go into a separate file
(unless it makes sense to group some changes into one file, e.g. a story).
During release the changes will be moved to CHANGELOG.md.

Each file should follow one of the below naming patterns:

- \<issue number>.md
or
- \<story number>.md
or
- \<pr number>.md
or
- \<random number>.md if none of other apply

The content of the file should look like this:

```
### <type of change>
- description of the change in one or max two sentences (#<issue> or !<pr>)
```

< type of change > can be one of:

- **Added** for new features.
- **Changed**: for changes in existing functionality.
- **Deprecated**: for soon-to-be removed features.
- **Removed**: for now removed features.
- **Fixed**: for any bug fixes.
- **Security**: in case of vulnerabilities.


## Example

```
### Fixed
- improve userdashboard filter performance (#2449)
```

0 comments on commit 2ec3367

Please sign in to comment.