Contributing

You want to contribute to the CDK?

The CDK is a open-souce project maintained by UniteLabs. If you encounter any bugs in our code or have suggestions for improvements or new features let us know by creating an issue on GitLab!

If you believe in this project and want to contribute more actively, send us a message to get developer access.

Code formatting with black

We use black to check all code for consistent formatting. Before you push your code to a feature branch, run black to check which files would be reformatted:

$ poetry run black --check src

You can either do the reformatting manually or use black to do this for you using:

$ poetry run black src

You can also run black on individual files like so:

$ poetry run black connector/features/examples/greeting_provider/greeting_provider.py

Code styling

To keep the code consistently styled between all contributors, we use pylint to enforce the the PEP8 style guidelines for beautiful code.

Run pylint before every commit to your feature branch. Specify the src directory in your project folder.

$ poetry run pylint --disable C,R src

Feature branches, commits, PRs and unicorns

Create a new branch for every feature you want to contribute. The name of a feature branches should start with Feature/ followed by the feature name, e.g. TimerProvider in CamelCase. Use the git checkout -b command to create and switch to a new branch.

$ git checkout -b 'Feature/TimerProvider'