Contributing to nisystemlink-clients-python

Contributions to nisystemlink-clients-python are welcome from all!

nisystemlink-clients-python is managed via git, with the canonical upstream repository hosted on GitHub.

nisystemlink-clients-python follows a pull-request model for development. If you wish to contribute, you will need to create a GitHub account, fork this project, push a branch with your changes to your project, and then submit a pull request.

See GitHub's official documentation for more details.

Important: Commit titles and messages should adhere to the Conventional Commits style to ensure proper semantic versioning.

Getting Started

To contribute to this project, it is recommended that you follow these steps:

Fork the repository on GitHub.
Run the unit tests on your system (see Testing section). 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 unit tests again (which include the tests you just added), and confirm that they all pass.
Send a GitHub Pull Request to the main repository's master branch. GitHub Pull Requests are the expected method of code collaboration on this project.

Testing

Before running any tests, you must have a supported version of Python (3.10+) and Poetry installed locally.

It is also helpful to install SystemLink Server and configure the NI Web Server to run on localhost.

To install all development dependencies required:

poetry install

To run commands and scripts, spawn a shell within the virtual environment managed by Poetry:

poetry shell
# Alternatively, you can prefix commands with "poetry run"
poetry run pytest

There are a handful of helpful tasks in the [tool.poe.tasks] section of the pyproject.toml file. These can be run using Poe like so:

poe types

To run all tests in place with your current python environment setup:

pytest

To only run the tests in one particular folder, run

pytest tests/myfolder

To run the SystemLink Cloud tests, create an API key and then run

pytest -m cloud --cloud-api-key XXXXX

To run the SystemLink Enterprise tests, obtain a session API key from the main-test cluster and then run

pytest -m enterprise --enterprise-uri "https://test-api.lifecyclesolutions.ni.com" --enterprise-api-key XXXXX

It is important to note that depending on the terminal you are using, you may need to escape special characters in the API key.

Security scanning with Snyk

This repository uses Snyk for security scanning to identify and fix vulnerabilities in code before they reach production. Snyk provides Static Application Security Testing (SAST) that scans your code for security issues as you develop.

IDE integration: Install the Snyk extension for Visual Studio Code or Visual Studio to get real-time security feedback while writing code. To suggest the Snyk extension to contributors, add .vscode/extensions.json or .vsconfig files to your project root. The VSCode Snyk extension has a richer feature set and is the preferred IDE for working with Snyk.
Pull request scanning: Snyk automatically scans PRs and posts comments for high/critical vulnerabilities.
Post-merge monitoring: Automated bugs are created for unresolved issues after code is merged.

Contributors within NI/Emerson: For detailed guidance on working with Snyk, including how to address security issues and create ignore records, see the Snyk reference.

Contributors outside of NI/Emerson: If you are having issues resolving a vulnerability Snyk identifies on your PR, consult with a code owner to understand your options for resolution.

Developer Certificate of Origin (DCO)

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

(taken from developercertificate.org)

See LICENSE for details about how nisystemlink-clients-python is licensed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!