Skip to content

docs: Updating contributing documentation #83

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
Lee31416 wants to merge 1 commit into from
Closed

docs: Updating contributing documentation #83

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
Contributor

@Marc-Antoine-Soucy Marc-Antoine-Soucy Mar 31, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

I'm not seeing any changes in the changelog file, does this project have one? Should breaking_changes.md be the one we should check instead?

Copy link
Author

@Lee31416 Lee31416 Mar 31, 2025

Choose a reason for hiding this comment

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

Well some packages have no changelogs and breaking change i thought about it but since it's not a breaking change I thought it wouldnt make much sense


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
Loading