Skip to content

Latest commit

 

History

History
89 lines (63 loc) · 2.64 KB

CONTRIBUTING.md

File metadata and controls

89 lines (63 loc) · 2.64 KB

Questions ?

If you have any questions, please create a new issue.

Contribute

If you like the project and think you could help with making it better, there are many ways you can do it:

  • Create new issue for new feature proposal or a bug
  • Implement existing issues.
  • Help with improving the documentation
  • Spread a word about the project to your collegues, friends, blogs or any other channels
  • Any other things you could imagine
  • Any contribution would be of great help and I will highly appreciate it!

Install for dev

For development
# Fork the repo
git clone https://github.com/mfesiem/msiempy.git
cd msiempy
# Install dev requirements
python3 -m pip install -r requirements.txt
# Install module
python3 ./setup.py install
# Hack and pull request

Run Tests

All tests are not compatible with any ESM instance. But all tests will be run once merged with develop branch

You might want to run per-file tests

pytest tests/auth/test_device.py

Or per-method test

python3 -m unittest tests.auth.test_event.T.test_add_note

Git flow

  • Commits to master branch are trigerring:

    • Tests on Windows and MacOS and Ubuntu + upload coverage
    • Generate documentation + publish to gh-pages

  • Commits to any branch are trigerring:

See the github actions workflows for more details.

Publish

Use the publish script to push tha package to PyPi and create a new tag, for Unix only. For more infos:

% ./publish.sh -h

Documentation

Documentation is automatically generated with pydoctor from docstrings.

Format use in docstrings is ReStructuredText.

The script buid_docs.sh integrate a mkdocs index to the pydoctor HTML files. This is a hack to documented multiple versions of msiempy. The index.md files under ./docs/<version>/index.md should be kept in the repo for mkdocs to be able to generate the navbar with links to different versions.

For more infos:

% ./build_docs.sh -h

Code analysis

Codacy

Code climate

Error report

Configure log file reporting in the configuration file and and look for "ERROR".
Useful shell command to get simple list of errors::

    cat /path/to/your/log/file | grep -i error | sort | uniq