Skip to content

Latest commit

 

History

History
54 lines (32 loc) · 1.23 KB

CONTRIBUTING.md

File metadata and controls

54 lines (32 loc) · 1.23 KB

Wanna contribute?

Welcome to our happy country of Lambdarest!

Lambdarest is heavily created in collaboration and we value all contributions.

Are you having issues?

Create issues or pull requests, no real guidelines given here.

If you feel like it, take a look around and see if the issue was posted before, but if not, thats ok too!

Have you made a PR?

A maintainer will review and take care of version bumping and release etc.

I am sure we can all work together and get your work released!

Development how-to

There is two ways of running the lint+tests both of them require the install of the dependencies mentioned in dev_requirements.txt

1. Run for current python version

Use the following commands to install requirements and run test-suite:

$ pip install -e ".[dev]"
$ rm -f test_readme.py
$ pytest --doctest-modules -vvv

Which

  • Installs all dev dependencies
  • runs pytest

for the current python version.

Linting

Be sure to see if linting is correct before commiting. The following make target fixes linting issues and makes you aware of errors

$ black tests/ lambdarest/

Packaging and publishing

python3 -m build
python3 -m twine upload dist/*