Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
38 lines (23 loc) · 660 Bytes

CONTRIBUTING.md

File metadata and controls

38 lines (23 loc) · 660 Bytes
Raw

Setup machine for development of PythonSearch

Developing PythonSearch

  1. Clone the repo
git clone git@github.com:jeanCarloMachado/PythonSearch.git
  1. Install the repo code in your enviroment
cd PythonSearch ;
# install the program in devevelopment mode
pip install -e .
  1. Create a feature branch, develop it!
git checkout -b my_dev_branch

Sending a modification

On every change that modifies the code make sure to change the CHANGELOG.md and to increase the version in pyproject.toml

Generating code docs

Run the following command and commit the results.

 pdoc --skip-errors --html python_search