Code Formatting Standards

Question

Code Formatting Standards

vin-nag opened this issue 3 years ago · comments

Hi,

I was looking to contribute to this repo. I understand that we need to agree to the DCO as a requirement. I was wondering if there were any particular code formatting styles recommended/enforced for this project?

Ilya Matiach · Answer 1 · Mon May 09 2022 21:33:12 GMT+0800 (China Standard Time)

hi @vin-nag contributions are welcome!
"I was wondering if there were any particular code formatting styles recommended/enforced for this project?"
Yes, you will need to run flake8 and isort, see:

https://github.com/interpretml/interpret-community/blob/813be7ae1705ab6c13434ad6a22152785a783153/.github/workflows/python-linting.yml

I usually run flake8 at the root level:

flake8 --max-line-length=119

It will tell you what style change will need to be made.

For isort, it will actually auto-correct the code. To see the issues, you just need to run:

isort . -c

To autocorrect the issues, you can remove the -c parameter:

isort .

It will auto-correct the imports for you.

If you have any other style suggestions please let us know.

Ilya Matiach · Answer 2 · Mon May 09 2022 21:37:06 GMT+0800 (China Standard Time)

Note these are run in the build gates, so if you send the PR they will automatically output all of the issues for you in the build output.

Ilya Matiach · Answer 3 · Sat May 14 2022 05:20:08 GMT+0800 (China Standard Time)

closed with PR #522 where I added a contributing guide to the website

Ilya Matiach · Answer 4 · Sat May 14 2022 05:25:27 GMT+0800 (China Standard Time)

see https://interpret-community.readthedocs.io/en/latest/contributing.html#

Ilya Matiach · Answer 5 · Sat May 21 2022 03:18:02 GMT+0800 (China Standard Time)

@vin-nag did you have any other questions about making contributions to this repository? Did you encounter any issues when trying to make a contribution?