CONTRIBUTING.md

Contributing

Getting Started

Fork the repository to your own account.

Clone the repository to a suitable location on your local machine.

git clone https://github.com/practo/tableau-parser.git

Note: This will clone the entire contents of the repository at the HEAD revision.

To update the project from within the project's folder you can run the following command:

git pull --rebase

Building

Install the project's dependencies.

pip install -r requirements.txt
pip install -r requirements-dev.txt

Install pre-commit hooks.

pre-commit install

Virtual Environment

It is better to keep a project specific virtual environment to not mix package versions between different projects.

A virtual environment is automatically created by pre-commit called py_env-default. If not created, run pre-commit run --all-files.

To activate the virtual environment use:

. py_env-default/bin/activate

Commit Guidelines

Before committing pre-commit hooks will run to check for source standards. If you want to run a check manually before committing use:

pre-commit run

Read pre-commit documentation to learn more about it.

Testing

Install the project's dependencies and then run the project's tests.

Feature Requests

If you have a suggestion for improving an existing feature, or would like to suggest a completely new feature, please file an issue with GitHub repository.

Bug Reports

A project isn't always perfect, but we strive to always improve on that work. You may file bug reports on the GitHub repository site.

Pull Requests

Along with our desire to hear your feedback and suggestions, we are also interested in accepting direct assistance in the form of new code or documentation.

Please feel free to file merge requests against GitHub repository.