Mr-Sunglasses / flet-cli

Creative Commons Zero v1.0 Universal
1 stars 2 forks source link

Add the black formatter GitHub Action #4

Closed Mayank1170 closed 2 years ago

Mayank1170 commented 2 years ago

Add the black formatter GitHub Action

Overview

Currently, there is no Code Formatter used in flet-cli, Our Goal is to add a Black code formattingr in flet-cli.

Description

Describe the solution you'd like - Add a GitHub action that checks a PR for coding style using black. The GHA should be able to format the code and commit it to the PR if the PR is not following the coding style.

Expected outcomes

A uniform coding style across flet-cli, that Autoformat code on every PR.

Skills

GitHub Actions, Python

Possible mentors

Kanishk Pachauri, Anjuman Hassan

Expected project size

50 hours.

Difficulty

Hard.

Srijan-SS02 commented 2 years ago

Add the black formatter GitHub Action

My Background and Technical Skills I have been into coding stuff since class 8th trying my hands on Python and its libraries like Pandas etc. Right now i'm handy with WebD, Python, C++ and in designing I have worked on Figma.

What problem are you trying to solve and Your Approach? So I am trying to add the black formatter through github action. Black formatter is python libraries which auto formats the code like indentation and other things. Which ultimately saves user time who will push there messy code. I have also created a sample github action in one of my repo which uses super-Linter to check format of code. linnk to it : https://github.com/Srijan-SS02/ActionDemo

Your Timeline to solve the problem. 19th Sep 2022 : get the project assigned by Mentors and try to interact with mentors 20th Sep 2022 : trying to solve the issue and trying to get helped by the mentors 21st Sep 2022 : wrapping up the issue and fixing the minor bugs if any

@Mr-Sunglasses @AnjumanHasan tagging maintainers for better reach

Srijan-SS02 commented 2 years ago

@AnjumanHasan @Mr-Sunglasses please review this PR and let me know if any changes are required