search

fmilthaler / FinQuant

A program for financial portfolio management, analysis and optimisation.
MIT License
1.34k stars 190 forks source link

Chore/auto formatting workflow #109

Closed fmilthaler closed 12 months ago

fmilthaler commented 1 year ago

This PR adds a new GitHub workflow. Purpose of that is, for every commit to either of the branches master or develop as well as any commit pushed to a branch that is in a PR with a base branch of either master or develop the new workflow should run and automatically apply code formatting with black, import sorting with isort as well as update the README.tex.md (porting changes over from README.md).

fmilthaler commented 12 months ago

@PietropaoloFrisoni This PR adds a new GitHub workflow. Purpose of that is, for every commit to either of the branches

Good news for you and any other contributor to FinQuant: There is no need to use black, isort etc locally. You just commit your changes, and code formatting is taken care of for you automatically. You can see the last commit in this PR is an automated commit that applies code formatting with black on some of the files we have neglected and or not applied black on lately.

This has been thoroughly tested.

PietropaoloFrisoni commented 12 months ago

@PietropaoloFrisoni This PR adds a new GitHub workflow. Purpose of that is, for every commit to either of the branches

  • master or
  • develop (a legacy branch, that I'm not giving up on just yet ;) ) as well as any commit pushed to a branch that is in a PR with a base branch of either
  • master or
  • develop the new workflow should run and automatically apply code formatting with black, import sorting with isort as well as update the README.tex.md (porting changes over from README.md). These are manual tasks that I tend to forget, hence I decided to automate it.

Good news for you and any other contributor to FinQuant: There is no need to use black, isort etc locally. You just commit your changes, and code formatting is taken care of for you automatically. You can see the last commit in this PR is an automated commit that applies code formatting with black on some of the files we have neglected and or not applied black on lately.

This has been thoroughly tested.

That's very nice. Thank you, Frank! I can't wait to test it : )