CONTRIBUTING.md

Contributing to the Lacework Go-sdk

Table Of Contents

• Before getting started?

• How to contribute

  • Reporting Bugs
  • Feature Requests
  • Pull Requests

• Developer Guidelines

Before getting started

Read the README.md

Poetry

pyenv install 3.8
pyenv virtualenv 3.8 python-sdk
pyenv local python-sdk

poetry install
poetry run pytest ...

pre-commit install --hook-type commit-msg --hook-type pre-push

Install Dependencies

https://python-poetry.org/docs/basic-usage/#installing-dependencies

Run

poetry run

https://python-poetry.org/docs/basic-usage/#installing-dependencies

How to contribute

There are 3 ways that community members can help contribute to the Lacework Python SDK. Reporting any issues you may find in the functionality or documentation. Or if you believe some functionality should exist within the SDK you can make a feature request. Finally, if you've gone one step further and made the changes to submit for a pull request.

Reporting Bugs

Ensure the issue you are raising has not already been created under issues.

If no current issue addresses the problem, open a new issue. Include as much relevant information as possible. See the bug template for help on creating a new issue.

Feature Requests

If you wish to submit a request to add new functionality or an improvement to the go-sdk then use the the feature request template to open a new issue

Pull Requests

When submitting a pull request follow the commit message standard.

Thanks, Project Maintainers