Skip to content

Latest commit

 

History

History
147 lines (101 loc) · 5.18 KB

CONTRIBUTING.md

File metadata and controls

147 lines (101 loc) · 5.18 KB

Contributing to Measurement Plug-In Service Extension Example

Contributions to the Measurement Plug-In Service Extension Example are welcome from all!

Measurement Plug-In Service Extension Example is managed via git, with the canonical upstream repository hosted on GitHub.

Measurement Plug-In Service Extension Example 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.

Please remember to sign off your commits (e.g., by using git commit -s if you are using the command line client). This amends your git commit message with a line of the form Signed-off-by: Name Lastname <name.lastmail@emailaddress.com>. Please include all authors of any given commit into the commit message with a Signed-off-by line. This indicates that you have read and signed the Developer Certificate of Origin (see below) and are able to legally submit your code to this repository.

See GitHub's official documentation for more details.

Getting Started

Prerequisites

  • (Optional) Install Visual Studio Code.
  • Install Git.
  • Install Python and add it to the PATH.
  • Install Poetry. Version >= 1.8.2

Clone or Update the Git Repository

To download the Measurement Plug-In Service Extension Example for Python source, clone its Git repository to your local PC.

git clone https://github.com/ni/measurement-plugin-service-extension-example.git

If you already have the Git repository on your local PC, you can update it

git checkout main

git pull

Install the Dependencies

From the package's subdirectory, run the poetry install command. This creates an in-project virtual environment (.venv) and installs the package's dependencies and dev-dependencies, as specified in its pyproject.toml and poetry.lock files.

poetry install

Activate the Virtual Environment (If Needed)

  • In the command prompt: poetry shell
  • In VS Code (link)

Steps to Contribute

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

  1. Make your change.
  2. 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.

Lint and Build Code

Lint Code for Style and Formatting

Use ni-python-styleguide to lint the code for style and formatting. This runs other tools such as flake8, pycodestyle, and black.

poetry run ni-python-styleguide lint

If there are any failures, try using ni-python-styleguide to fix them, then lint the code again. If ni-python-styleguide doesn't fix the failures, you will have to manually fix them.

poetry run ni-python-styleguide fix
poetry run ni-python-styleguide lint

Mypy Type Checking

Use Mypy to type check the code.

poetry run mypy src

Bandit Security Checks

Use Bandit to check for common security issues.

poetry run bandit -c pyproject.toml -r <directory>

Adding Dependencies

You can add new dependencies using poetry add or by editing the pyproject.toml file.

When adding new dependencies, use a >= version constraint (instead of ^) unless the dependency uses semantic versioning.

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 Measurement Plug-In Service Extension Example is licensed.