Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update contributing.md adding details about a product oriented changelog #5925

Merged
merged 1 commit into from
Mar 20, 2025
Merged

chore: update contributing.md adding details about a product oriented changelog #5925

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,14 +48,17 @@ For an example of this process, see PRs

### Documentation Updates

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

> [*] 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.
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.

## Git Commit Messages

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