diff --git a/README.md b/README.md index e554c826d2491a256b60587858ac0ef0cdf3db30..605e1f0c43569ad5546b1bcaa6247a6fb5074475 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,11 @@ # Example Python Package -An example repository of an CI/CD pipeline for building, testing and publishing a python package +An example repository of an CI/CD pipeline for building, testing and publishing a python package. +If you find some missing functionality with regards to CI/CD, testing, linting or something else, feel free to make a merge request with the proposed changes. + + +## Example of README.md contents below: ## Installation ``` @@ -15,5 +19,10 @@ from map import cool_module cool_module.greeter() # prints "Hello World" ``` +## Contributing + +To contribute, please create a feature branch and a "Draft" merge request. +Upon completion, the merge request should be marked as ready and a reviewer should be assigned. + ## License This project is licensed under the Apache License Version 2.0