Skip to content

Latest commit

 

History

History
63 lines (46 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

63 lines (46 loc) · 1.94 KB
Raw

Questions

If you are having difficulties using the APIs or have a question about the GLPI-SDK-PYTHON, please ask a question.

Issues

If you encounter an issue with the Python SDK, you are welcome to submit a bug report. Before that, please search for similar issues. It's possible somebody has encountered this issue already.

Pull Requests

If you want to contribute to the repository, here's a quick guide:

  1. Fork the repository
  2. develop and test your code changes with [pytest]. * Respect the original code style guide. * Only use spaces for indentation. * Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change. * Check for unnecessary whitespace with git diff --check before committing.
  3. Make the test pass
  4. Commit your changes
  5. Push to your fork and submit a pull request to the dev branch

Running the tests

You probably want to set up a virtualenv.

  1. Clone this repository: 
    git clone https://github.com/truly-systems/glpi-sdk-python.git
  2. Install the sdk as an editable package using the current source: 
    pip install --editable .
  3. Install the test dependencies with: 
    pip install -r requirements-dev.txt
  4. Run the test cases with (now we're only testing PEP8): 
    make check-syntax

Aditional tests

  • Install tests dependencies

make dependencies

  • Test PEP8 syntax

make check-syntax

  • Test installation setup

make test-setup

Additional Resources