Ekeany / Boruta-Shap

A Tree based feature selection tool which combines both the Boruta feature selection algorithm with shapley values.

MIT License

581 stars 88 forks source link

Adds infrastructure and testing configuration #6

Closed rorybyrne closed 4 years ago

rorybyrne commented 4 years ago

What does this PR do?

Adds a tox.ini file to automate testing
Adds coverage to calculate the % of the source code "covered" by tests.
Adds a .coveragerc file to configure the coverage tool.
Adds a simple test to instantiate the main class

Some more goodies:

Adds dependabot configuration in .dependabot/
Adds a .github/ directory
Adds issue template
Adds a PR template
Adds a workflow for linting/testing via Github Actions
Adds a .gitignore file

Why are we doing this?

Tox allows us to automatically test the package in different environments (e.g. python 3.6, 3.7, etc.)
Tox installs the package as a third-party library, which simulates a real installation situation.
Dependabot will spam the repo with PRs unless you put it on a leash.
Standardize issue formats
Standardize PR formats
Use Github Actions to run tests automatically when a push is received

Notes

Closes #4 Closes #7