Skip to content

Commit e4504c8

Browse files
committed
docs: align notation for change log file name pattern
also add a note that we are using English only for change log
1 parent f2e4ad3 commit e4504c8

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

.github/pull_request_template.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Please convert it to a draft if any of the following conditions are not met. Rev
1010

1111
- [ ] Added tests for the changes
1212
- [ ] Changed lines covered in coverage report
13-
- [ ] Change log has been added to `changes/{ce,ee}/(feat|perf|fix)-<PR-id>.en.md` files
13+
- [ ] Change log has been added to `changes/(ce|ee)/(feat|perf|fix)-<PR-id>.en.md` files
1414
- [ ] For internal contributor: there is a jira ticket to track this change
1515
- [ ] If there should be document changes, a PR to emqx-docs.git is sent, or a jira ticket is created to follow up
1616
- [ ] Schema changes are backward compatible

CONTRIBUTING.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -84,8 +84,9 @@ The footer should contain any information about **Breaking Changes** and is also
8484

8585
Changes affecting EMQX functionality shall be described in a separate markdown file under `changes` directory.
8686

87-
File name pattern: `changes/{ce,ee}/(feat|perf|fix)-<PR-id>.en.md`, where:
87+
File name pattern: `changes/(ce|ee)/(feat|perf|fix)-<PR-id>.en.md`, where:
8888

8989
- `ce,ee`: Indicates whether given change affects community and enterprise edition (`ce`), or enterprise edition only (`ee`); for any change only one file is needed as enterprise edition absorbs all changes from the community edition automatically. When in doubts, one could consult [documentation](https://www.emqx.io/docs/en/latest/). Enterprise features have a corresponding "Tip" banner, see for example [here](https://www.emqx.io/docs/en/v5.1/data-integration/data-bridge-influxdb.html).
9090
- `feat|perf|fix`: Whether the change is a new functionality (`feat`), performance improvement (`perf`), or a bug fix (`fix`).
9191
- `PR-id`: Github pull request id. Since pull request id cannot be known before the PR is actually created, it's common to add change log entry in a separate commit.
92+
- `en`: ISO 639-1 language code indicating the language the change log entry is written in. Right now we are only accepting entries in English.

0 commit comments

Comments
 (0)