From 7ffb7975fcbc1ea20493a78d68c37c387fd494b6 Mon Sep 17 00:00:00 2001 From: Brad Keryan Date: Wed, 1 Oct 2025 13:57:43 -0500 Subject: [PATCH 1/5] docs: Update CONTRIBUTING.md to cover getting started, testing, and publishing --- CONTRIBUTING.md | 66 +++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 56 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 094361e..4edc552 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Contributing to `ni/python-actions` +# Contributing to `ni/python-actions` Contributions to `ni/python-actions` are welcome from all! @@ -19,15 +19,61 @@ this repository. See [GitHub's official documentation](https://help.github.com/articles/using-pull-requests/) for more details. -# Getting Started - -- TODO: include build steps here. - -# Testing - -- TODO: include testing steps here. - -# Developer Certificate of Origin (DCO) +## Getting Started + +To contribute to this project, it is recommended that you follow these steps: + +- Fork the repository on GitHub. +- Run the PR workflow on your fork of the repository. At this point, if any tests fail, do not begin + development. Try to investigate these failures. If you're unable to do so, report an issue through + our GitHub issues page. +- Write new tests that demonstrate your bug or feature. Ensure that these new tests fail. +- Make your change. +- Run all the regression tests again (including the tests you just added), and confirm that they all + pass. +- Send a GitHub Pull Request to the main repository's `main` branch. GitHub Pull Requests are the + expected method of code collaboration on this project. + +## Testing + +To run the `ni/python-actions` regression tests, run the following command: + +```bash +gh workflow run PR.yml --ref users/me/my-dev-branch +``` + +View the workflow status and logs using the GitHub web UI. + +## Publishing a Release + +You can publish `ni/python-actions` by creating a GitHub release in the `ni/python-actions` repo. +Here are the steps to follow to publish the package: + +- From the main GitHub repo page, select "Create a new release". +- On the "New Release" page, create a new tag using the "Select Tag" drop down. The tag must be the + letter 'v' followed the version number. Example: v0.1.2. +- Enter a title in the "Release title" field. The title should contain the repo name and version + tag. For example: ni/python-actions v0.1.2. +- Click "Generate release notes" and edit the release notes. +- Delete entries for PRs that do not affect users, such as "chore(deps):" and "fix(deps):" PRs. + However, consider including significant dependency updates, such as major version updates. +- Consider grouping related entries. +- Reformat entries to be more readable. For example, change "Blah blah by so-and-so in \#123" to + "Blah blah (\#123)". +- If this is a pre-release release, check the "Set as a pre-release" checkbox. +- Click "Publish release". +- This repository does not have a publish workflow yet, so you must manually update the `v{major}` + and `v{major}.{minor}` tags: + + ```bash + git checkout v0.1.2 + git tag -f v0.1 + git tag -f v0 + git push -f origin v0.1 + git push -f origin v0 + ``` + +## Developer Certificate of Origin (DCO) Developer's Certificate of Origin 1.1 From 09d1679fb11e150ddfc2c4968b7d1762d690e65a Mon Sep 17 00:00:00 2001 From: Brad Keryan Date: Wed, 1 Oct 2025 14:04:15 -0500 Subject: [PATCH 2/5] docs: Add note about immutable releases --- CONTRIBUTING.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4edc552..2988970 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -73,6 +73,9 @@ Here are the steps to follow to publish the package: git push -f origin v0 ``` +> [!NOTE] This GitHub project has immutable releases enabled. Once you create a release, you can +> only edit the title and description. You cannot delete the full release tag (e.g. `v0.1.2`). + ## Developer Certificate of Origin (DCO) Developer's Certificate of Origin 1.1 From f9aedaddd8506bdf98afa09ecd4c3206ba664471 Mon Sep 17 00:00:00 2001 From: Brad Keryan Date: Wed, 1 Oct 2025 14:05:48 -0500 Subject: [PATCH 3/5] docs: Fix note formatting --- CONTRIBUTING.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2988970..924b4e4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -73,8 +73,9 @@ Here are the steps to follow to publish the package: git push -f origin v0 ``` -> [!NOTE] This GitHub project has immutable releases enabled. Once you create a release, you can -> only edit the title and description. You cannot delete the full release tag (e.g. `v0.1.2`). +> [!NOTE] +> This GitHub project has immutable releases enabled. Once you create a release, you can only edit +> the title and description. You cannot delete the full release tag (e.g. `v0.1.2`). ## Developer Certificate of Origin (DCO) From d8404cd6f009b7f38cb20ec077e1e629931bf85d Mon Sep 17 00:00:00 2001 From: Brad Keryan Date: Wed, 1 Oct 2025 14:06:58 -0500 Subject: [PATCH 4/5] docs: Clarify what you can do with published releases --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 924b4e4..ead77dc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -74,8 +74,8 @@ Here are the steps to follow to publish the package: ``` > [!NOTE] -> This GitHub project has immutable releases enabled. Once you create a release, you can only edit -> the title and description. You cannot delete the full release tag (e.g. `v0.1.2`). +> This GitHub project has immutable releases enabled. Once you publish a release, you can only edit +> the title and description. You cannot modify the full release tag (e.g. `v0.1.2`). ## Developer Certificate of Origin (DCO) From 60858bba33a211870d35410bbd835e9f0a46ec61 Mon Sep 17 00:00:00 2001 From: Brad Keryan Date: Fri, 3 Oct 2025 13:44:53 -0500 Subject: [PATCH 5/5] docs: Be more specific about who can create releases Co-authored-by: mshafer-NI <23644905+mshafer-NI@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ead77dc..fb7148e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,7 +46,7 @@ View the workflow status and logs using the GitHub web UI. ## Publishing a Release -You can publish `ni/python-actions` by creating a GitHub release in the `ni/python-actions` repo. +Maintainers can publish `ni/python-actions` by creating a GitHub release in the `ni/python-actions` repo. Here are the steps to follow to publish the package: - From the main GitHub repo page, select "Create a new release".