Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Executable tutorial proposal: Integrating Code Climate in developers workflow with shell scripts and docker #1278

Merged
merged 9 commits into from
Apr 20, 2021
17 changes: 17 additions & 0 deletions contributions/executable-tutorial/badal-johennin/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Integrating Code Climate in developers workflow with shell scripts and docker
## Members
Lee Badal (badal@kth.se)

GitHub: [@LeeBadal](https://github.com/LeeBadal)

Johan Henning (johennin@kth.se)

GitHub [@johennin](https://github.com/johennin)

## Proposal
Code Climate is a lint tool that can be integrated online on github, it also has a CLI for local linting. We plan to create a executable tutorial of how to integrate Code Climate in a repository's build/test script for local execution. This, to enable a repository's developers to have the benefits of using a powerful linting tool without any previous experience. It can also prevent that pull requests will fail on checks which could have easily been prevented and at the same time assisting in maintaining the desired structure of the code.
## Proposed tools
* [Code Climate CLI](https://docs.codeclimate.com/)
* Docker
* Shell scripts
* Git