Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
151 lines (102 loc) · 3.18 KB

CONTRIBUTING.md

File metadata and controls

151 lines (102 loc) · 3.18 KB

Contribute to docs

You may run the docs locally with docker

docker run --rm -it -p 8000:8000 --user $(id -u):$(id -g) -v ${PWD}:/docs squidfunk/mkdocs-material serve

Docs are then available on http://localhost:8000.

Publish docs

Create the following file inside ~/.netrc and replace <account> and <token> with your github account and personal access token.

machine github.com
login <account>
password <token>

machine api.github.com
login <account>
password <token>

machine uploads.github.com
login <account>
password <token>

Github personnal access token can be here. (repo must be checked)

docker run --rm -it -p 8000:8000 --user $(id -u):$(id -g) -v ${PWD}/..:/docs -v ${HOME}/.netrc:/.netrc:ro --workdir=/docs/ddb squidfunk/mkdocs-material gh-deploy

Semantic release and conventional commits

ddb Changelog and released version number are automatically generated from your commit messages using conventional commits.

Any pull request containing invalid commit messages will be rejected.

Your can use commitizen to help create commit with valid messages.

cz commit

Configure development environment (Windows)

  • Clone this repository and cd into it

You should use pyenv-win to install and manage your python versions on Windows.

  • Install python 3.11.x
pyenv install 3.11.9
pyenv local 3.11.9
pyenv rehash
python --version  # Python 3.11.9
  • Create virtualenv
python -m venv %USERPROFILE%\.pyenv\pyenv-win\versions\3.11.9-ddb
pyenv local 3.11.9-ddb
pyenv rehash
python --version  # Python 3.11.9
  • Install dependencies
pip install -e .[dev]
  • Enable pre-commit hooks

bash pre-commit install

  • Download ytt binary and make it available in PATH

  • Check development version is available in your virtualenv

# On windows, use `python -m ddb` instead of ddb only
python -m ddb --version  # Should display a version ending with .dev0
  • Run tests with pytest
pytest

Configure development environment (Linux)

You should use pyenv to install and manage your python versions on Linux.

  • Clone this repository and cd into it

  • Install python 3.11.x

pyenv install 3.11.9
pyenv local 3.11.9
python --version  # Python 3.11.9
  • Create virtualenv
pyenv virtualenv 3.11.9 3.11.9-ddb
pyenv local 3.11.9-ddb
python --version  # Python 3.11.9
  • Install dependencies
pip install -e .[dev]
  • Enable pre-commit hooks

bash pre-commit install

  • Download ytt binary and make it available in PATH

  • Check development version is available in your virtualenv

ddb --version  # Should display a version ending with .dev0
  • Run tests with pytest
pytest

Build and release process

The release process is automated through Github Actions and semantic-release, triggered when pushing to master.