Content Comparison

Anchor
First-time-setup First-time-setup

Anchor
Contributetothevss-cli-First-time-setup Contributetothevss-cli-First-time-setup

First time setup

1. Download and install the Latest version of git.

2. Configure git with your username and email matching your GitLab account:

...

python3 -m venv vss-cli
source vss-cli/bin/activate

Anchor
Start-Coding Start-Coding

Anchor
Contributetothevss-cli-Start-Coding Contributetothevss-cli-Start-Coding

Start Coding

1. Create a branch to identify the issue you would like to work on (e.g. issue-999):

...

git push origin issue-999

1. Celebrate 🎉

Anchor
Build-docs Build-docs

Anchor
Contributetothevss-cli-Build-docs Contributetothevss-cli-Build-docs

Build docs

1. Install requirements:

pip install .[dev]

...

In any case, the resulting files are located in docs/_build.

Anchor
Developing-Plugins Developing-Plugins

Anchor
Contributetothevss-cli-Developing-Plugins Contributetothevss-cli-Developing-Plugins

Developing Plugins

Plugin developers need to register their sub-commands or sub-groups to either of the following entry-points in their setup.py that is loaded by the vss-cli core package:

...