Skip to content

Commit

Permalink
update contribution docs
Browse files Browse the repository at this point in the history
  • Loading branch information
arthanson committed Apr 9, 2024
1 parent 4616c2a commit 31ec393
Showing 1 changed file with 13 additions and 20 deletions.
33 changes: 13 additions & 20 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,27 +69,28 @@ Ready to contribute? Here's how to set up `netbox-healthcheck-plugin` for local
$ git clone [email protected]:your_name_here/netbox-healthcheck-plugin.git
```

3. Install dependencies and start your virtualenv:
3. Activate the NetBox virtual environment (see the NetBox documentation under [Setting up a Development Environment](https://docs.netbox.dev/en/stable/development/getting-started/)):

```
$ poetry install -E test -E doc -E dev
$ source ~/.venv/netbox/bin/activate
```

4. Create a branch for local development:
4. Add the plugin to NetBox virtual environment in Develop mode (see [Plugins Development](https://docs.netbox.dev/en/stable/plugins/development/)):

To ease development, it is recommended to go ahead and install the plugin at this point using setuptools' develop mode. This will create symbolic links within your Python environment to the plugin development directory. Call setup.py from the plugin's root directory with the develop argument (instead of install):

```
$ git checkout -b name-of-your-bugfix-or-feature
$ python setup.py develop
```

Now you can make your changes locally.

5. When you're done making changes, check that your changes pass the
tests, including testing other Python versions, with tox:
5. Create a branch for local development:

```
$ poetry run tox
$ git checkout -b name-of-your-bugfix-or-feature
```

Now you can make your changes locally.

6. Commit your changes and push your branch to GitHub:

```
Expand All @@ -108,21 +109,13 @@ Before you submit a pull request, check that it meets these guidelines:
2. If the pull request adds functionality, the docs should be updated. Put
your new functionality into a function with a docstring, and add the
feature to the list in README.md.
3. The pull request should work for Python 3.6, 3.7, 3.8 and 3.9. Check
3. The pull request should work for Python 3.10, 3.11 and 3.12. Check
https://github.com/netbox-community/netbox-healthcheck-plugin/actions
and make sure that the tests pass for all supported Python versions.


## Deploying

A reminder for the maintainers on how to deploy.
Make sure all your changes are committed (including an entry in CHANGELOG.md).
Then run:

```
$ poetry run bump2version patch # possible: major / minor / patch
$ git push
$ git push --tags
```

GitHub Actions will then deploy to PyPI if tests pass.
Make sure all your changes are committed (including an entry in CHANGELOG.md) and that all tests pass.
Then in the github project go to `Releases` and create a new release with a new tag. This will automatically upload the release to pypi:

0 comments on commit 31ec393

Please sign in to comment.