Skip to content

Commit 815a175

Browse files
committed
chore: update contributing.md adding details about a product oriented changelog, #5939
1 parent 1b875da commit 815a175

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

CONTRIBUTING.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -48,14 +48,17 @@ For an example of this process, see PRs
4848

4949
### Documentation Updates
5050

51-
- Any major changes should be added to the [CHANGELOG](CHANGELOG.md).
51+
- Any major changes should be added to the [CHANGELOG](CHANGELOG.md)[*].
5252
- Mention any required documentation changes in the description of your pull request.
5353
- If adding or updating an RPC endpoint, ensure the change is documented in the
5454
OpenAPI spec: [`./docs/rpc/openapi.yaml`](./docs/rpc/openapi.yaml).
5555
- If your code adds or modifies any major features (struct, trait,
5656
test, module, function, etc.), each should be documented according
5757
to our [coding guidelines](#Coding-Guidelines).
5858

59+
> [*] The Changelog focuses on product changes. A "major change" refers to updates that have a direct impact on the end user, such as introducing new features, modifying existing functionality, or optimizing runtime performance.
60+
On the other hand, changes that do not need to be reflected in the Changelog include code refactoring, writing tests, or automating processes, as these do not directly affect the user experience.
61+
5962
## Git Commit Messages
6063

6164
Aim to use descriptive git commit messages. We try to follow [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/).

0 commit comments

Comments
 (0)