From f9879dfd20f35f3621001bd23255be39e6bbc0b8 Mon Sep 17 00:00:00 2001 From: TheGupta2012 Date: Tue, 13 Aug 2024 14:40:03 +0530 Subject: [PATCH] update-contribs --- CHANGELOG.md | 1 + CONTRIBUTING.md | 2 ++ 2 files changed, 3 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 34012fa..4c57e0e 100644 --- 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 index b460f1c..9fe2492 100644 --- 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)