Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
125 lines (83 loc) · 4.73 KB

CONTRIBUTING.md

File metadata and controls

125 lines (83 loc) · 4.73 KB

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

General Tips for Working on GitHub

  • Register for a free GitHub account if you haven't already.
  • You can use GitHub Markdown for formatting text and adding images.
  • To help mitigate notification spam, please avoid "bumping" issues with no activity. (To vote an issue up or down, use a 👍 or 👎 reaction.)
  • Please avoid pinging members with @ unless they've previously expressed interest or involvement with that particular issue.
  • Familiarize yourself with this list of discussion anti-patterns and make every effort to avoid them.

Types of Contributions

Report Bugs

Report bugs at https://github.com/CESNET/cesnet_service_path_plugin/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

Write Documentation

Cesnet ServicePath Plugin could always use more documentation, whether as part of the official Cesnet ServicePath Plugin docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/CESNET/cesnet_service_path_plugin/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

The plugin requires a running NetBox instance with the plugin installed. You can set this up in several ways — choose whichever fits your workflow:

  • Docker (recommended): use the docker compose stack from this repository (see README.md)
  • Dev container: open the repository in VS Code with the provided devcontainer configuration
  • Local NetBox: follow the NetBox development setup guide and install the plugin into the same virtual environment

Regardless of the setup, the steps below apply.

  1. Fork the cesnet_service_path_plugin repo on GitHub.

  2. Clone your fork locally:

    git clone git@github.com:your_name_here/cesnet_service_path_plugin.git

  3. Install the plugin in editable mode into your NetBox environment:

    # Local venv
pip install -e /path/to/cesnet_service_path_plugin

# Docker
docker compose exec netbox pip install -e /opt/netbox/netbox/plugins/cesnet_service_path_plugin

    Editable mode creates a symlink so source changes are picked up without reinstalling.

  4. Create a branch for local development:

    git checkout -b name-of-your-bugfix-or-feature

  5. Run the tests to verify your changes (see the Testing section below).

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

    git add <specific files>
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  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 with Python 3.12+ (required by NetBox 4.5+). Check https://github.com/CESNET/cesnet_service_path_plugin/actions and make sure that the tests pass.

Deploying

A reminder for the maintainers on how to deploy. 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.