Add black check to Python files in CI

talaia-labs / rust-teos

The Eye of Satoshi - Lightning Watchtower

https://talaia-labs.github.io/talaia.watch/

MIT License

136 stars 63 forks source link

Add black check to Python files in CI #233

Closed anipaul2 closed 1 year ago

anipaul2 commented 1 year ago

Fixes #230

Description This PR adds a new job in the CI that checks the formatting of Python files using Black. This ensures that all Python files follow the same code styling guidelines, making the codebase cleaner and easier to read.

Changes

Modified .github/workflows/build.yaml to include a new job for Black checks.

Please let me know if any changes are required.

mariocynicys commented 1 year ago

Also this should be a one commit PR, and sign the commit.

anipaul2 commented 1 year ago

Also this should be a one commit PR, and sign the commit.

I thought of signing when all the checks get successfully passed.

mariocynicys commented 1 year ago

Rebase on the latest master and give a short commit message like Use black for `.py` files formatting, the commit message you are using right now would be nice as a description instead.

anipaul2 commented 1 year ago

Rebase on the latest master and give a short commit message like Use black for `.py` files formatting, the commit message you are using right now would be nice as a description instead.

There is a option which shows update branch and two list which are:-

Update with merge commit
Update with rebase

Are you suggesting me to select the second option?

mariocynicys commented 1 year ago

There is a option which shows update branch and two list which are

Neither of these. I mean rebasing master on your branch locally and then force pushing on this feature branch. For this you want to:

Make sure you have the remote master up to date: git fetch --all.
Rebase on the remote's master: git rebase REMOTE_NAME/master (for instance, I have my REMOTE_NAME as talaia, which points to https://github.com/talaia-labs/rust-teos, you want to pick the remote name you gave for that).
Fix any conflicts, I guess in this case there won't be any.
Sign the commit you introduced by amending it.
Force push, and you will be connected to master.

anipaul2 commented 1 year ago

There is a option which shows update branch and two list which are

Neither of these. I mean rebasing master on your branch locally and then force pushing on this feature branch. For this you want to:

Make sure you have the remote master up to date: git fetch --all.

Rebase on the remote's master: git rebase REMOTE_NAME/master (for instance, I have my REMOTE_NAME as talaia, which points to https://github.com/talaia-labs/rust-teos, you want to pick the remote name you gave for that).

Fix any conflicts, I guess in this case there won't be any.

Sign the commit you introduced by amending it.

Force push, and you will be connected to master.

Done. Thanks for the point-to-point explanation.

sr-gi commented 1 year ago

Needs rebase