Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation for contributors #9

Open
djmgit opened this issue Dec 6, 2019 · 0 comments
Open

Improve documentation for contributors #9

djmgit opened this issue Dec 6, 2019 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@djmgit
Copy link
Collaborator

djmgit commented Dec 6, 2019

Documentations for contributors needs to be improved.

Presently only way to run Saberx mentioned in the doc is to run sudo python3 setup.py install
Running this command again and again while developing can prove to be tiring.

Saberx can be also run as a module using python3 -m saberx.driver.driver -f [config_file]
This needs to be mentioned in the doc.
So for development purpose, one can follow the following steps to run Saberx and test their
changes:

  • sudo pip3 install -r requirements.txt
  • hack, hack, hack...
  • python3 -m saberx.driver.driver -f [config_file]

Also there needs to be doc for running tests, lint test and coverage.

Tests can be performed by simple running pytest from the root directory.
Lint test can performed by simply running flake8 from the root directory
Coverage can be determined by running pytest --cov=./ from the root directory

Lastly, while developing and adding new features or fixing bugs, one might want to keep it
separate from the global installation. This can be achieved by using any isolation tool, like
virtualenv. We also need doc on how to setup Saberx from within virtualenv.

All these things needs to be documented in CONTRIBUTING.md.

@djmgit djmgit added documentation Improvements or additions to documentation good first issue Good for newcomers labels Dec 6, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant