update-contribs

qBraid · Aug 13, 2024 · f9879df · f9879df
1 parent 714ae6a
commit f9879df
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -21,6 +21,7 @@ Types of changes:
 ### 📜  Documentation 
 * Housekeeping updates for release ( [#135](https://github.com/qBraid/qbraid-qir/pull/135) )
 * Update `CHANGELOG.md` to add new template ( [#137](https://github.com/qBraid/qbraid-qir/pull/137) )
+* Update `CONTRIBUTING.md` to mention changelog updates ( [#140](https://github.com/qBraid/qbraid-qir/pull/140) )
 
 ### 🐛  Bug Fixes
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -30,6 +30,8 @@ For code changes, please ensure that:
 3. All integration tests, including docs and linters, are passing.
 4. New functions and classes are annotated with Python type hints to support `py.typed`.
 
+Once PR has been validated by the maintainers, please ensure to update the [`CHANGELOG.md`](https://github.com/qBraid/qbraid-qir/blob/main/CHANGELOG.md) with a description of the PR and its link. You can refer to the [past release changelogs](https://github.com/qBraid/qbraid-qir/releases/tag/v0.2.2) as an example. Please make sure to correctly classify your work under one of the available contribution types.
+
 ### Run tests
 
 Workflow: [`main.yml`](.github/workflows/main.yml)