Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 22 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing to nipanel-python
# Contributing to nipanel-python

Contributions to nipanel-python are welcome from all!

Expand Down Expand Up @@ -26,7 +26,26 @@ This is the command to generate the files in /src/ni/pythonpanel/v1/:

# Testing

- TODO: include testing steps here.
## Simple development loop

```
# Create a new branch
git fetch
git switch --create users/{username}/{branch-purpose} origin/main

# Install the project dependencies
poetry install --sync

# ✍ Make source changes

# Run the analyzers -- see files in .github/workflows for details
poetry run ni-python-styleguide lint
poetry run mypy
poetry run bandit -c pyproject.toml -r src/nipanel

# Run the tests
poetry run pytest -v
```

# Developer Certificate of Origin (DCO)

Expand Down Expand Up @@ -59,4 +78,4 @@ This is the command to generate the files in /src/ni/pythonpanel/v1/:
(taken from [developercertificate.org](https://developercertificate.org/))

See [LICENSE](https://github.com/ni/<reponame>/blob/main/LICENSE)
for details about how \<reponame\> is licensed.
for details about how \<reponame\> is licensed.
2 changes: 1 addition & 1 deletion src/nipanel/_typing.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
Do not add project-specific types to this submodule.
Many of these symbosl are references to `None` at run time. Clients of this submodule should use
Many of these symbols are references to `None` at run time. Clients of this submodule should use
`from __future__ import annotations` to avoid parsing type hints at run time.
"""

Expand Down