carlosrsabreu / devo-abastecer

Twitter bot that publishes weekly the fuel prices updates on Madeira island.
https://twitter.com/devoabastecer
MIT License
10 stars 2 forks source link

[FEATURE]: General Optimizations #21 #22

Closed HarryVasanth closed 1 year ago

HarryVasanth commented 1 year ago

Related issues

Closes #21

What does this PR do?

Clearly state the reason for this change. What problem is it solving or feature is it adding?

  • Prettified codebase
  • Refactored codebase
  • Added standardized linting and formatting

Solution Overview

Provide an overview of the solution implemented in this pull request. This should be a high level overview without getting into technical details. If applicable, include screenshots of UI or use GitHub compliant mermaid graphs to visually represent the solution.

Implementation Details

Explain the details of the implementation and the reasoning behind it. Where should the reviewer start?

Dntfreitas commented 1 year ago

LGTM

HarryVasanth commented 1 year ago

Looks awesome!! Nice work!

Just a note: is there a way to create a lint file in this project so these rules would be applied when someone changes and saves the file locally? This way, the number of PRs to accept and the chances of someone having the code formatted in the "wrong" way would be less. Let me know your thoughts, @HarryVasanth

There are no specific lint config for this. For py, literally the whole world uses Black and it is available as a linter in all the mainstream code editors. The json and md files are formatted using Prettier which has more than 5.2 million dependant projects.

HarryVasanth commented 1 year ago

After speaking with @carlosrsabreu, I am removing the additional step of approving the pull-request created by the black formatter. From now on, all the file types in the workflow (json, md, py) that are pushed to the main branch will be formatted accordingly.