Skip to content

docs: Updating contributing documentation #103

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

Closed
wants to merge 1 commit into from
Closed

docs: Updating contributing documentation #103

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
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,27 @@ can build and all tests pass, as well as follow the current coding guidelines.
When submitting a pull request, please use our [pull request
template](.github/PULL_REQUEST_TEMPLATE.md).

**How to use the pull request template**

Proposed Changes:
Check the item in the list that corresponds to the type of change you're making. This should align with your conventional commit message.

Description:
Add a quick description of your changes.

Impact on version:
Please check the impact of your changes on the version. This should align with the changes made to the changelog file.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

BREAKING_CHANGES.md should be the one we look at, no?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well that's why I said the pr template doesn't align with what i wrote there on some packages


PR Checklist:
This list is a reminder of things that are often forgotten when making a pull request. Put an `x` in all the boxes that apply to your changes.
Don't forget to fill the Contextual section below it.

Other information:
Add any other information that is relevant to your pull request.

Internal Issue:
If your pull request is related to an internal issue, please add the issue number here.

Pull requests should all be done to the **main** branch.

---
Expand Down