Skip to content

Latest commit

 

History

History
79 lines (54 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

79 lines (54 loc) · 1.59 KB
Raw

Contributing

Python code style

black

We use black code formatter.

  • Revision: 20.8b1 or branch stable.
  • See configuration in pyproject.toml.

Install:

python -m pip install black

Run before each commit:

black .

License

We use addlicense license checker.

Install:

conda install go
export PATH=${PATH}:`go env GOPATH`/bin
go get -u github.com/google/addlicense

Run before each commit:

export PATH=${PATH}:`go env GOPATH`/bin
addlicense -l apache -c "Intel Corporation" numba_dppy/**/*.py numba_dppy/*.py setup.py

Security

Bandit

We use Bandit to find common security issues in Python code.

Install: pip install bandit

  • Revision: 1.7.0

Run before each commit: bandit -r numba_dppy -lll

Documentation

Generating documentation

Install Sphinx and plugins:

pip install sphinx autodoc recommonmark sphinx-rtd-theme

Generate HTML:

cd docs
make html

Generated documentation will be in docs/_build/html.

Uploading to GitHub Pages

Documentation for GitHub Pages is placed in following branch gh-pages.

Folders:

  • dev folder contains current documentation for default branch.
  • 0.12.0 folder and other similar folders contain documentation for releases.
  • latest folder is a link to the latest release folder.

Copy generated documentation into corresponding folder and create pull request to gh-pages branch.