[MISC] add CONTRIBUTING.md

[ziyanx02]

Add CONTRIBUTING.md.

[YilingQiao]

Hi, could you please test if the pre-commit hook is working as expected? I want to set the line width to 120, but it seems to format everything with a smaller value.

[ziyanx02]

Hi, could you please test if the pre-commit hook is working as expected? I want to set the line width to 120, but it seems to format everything with a smaller value.

I will try it tomorrow

[zswang666]

Should we add guide for test/check in CI on local machine?

black --check .
black . # to auto-format if the above check failed
python -m unittest discover tests

[ziyanx02]

Seems those CI tests require >6G gpu memory so I will add local tests as optional.

As for auto-reformat, I got 19 files to be reformatted after running black --check . XD. That doesn't seem right, does it?

[ziyanx02]

Hi, could you please test if the pre-commit hook is working as expected? I want to set the line width to 120, but it seems to format everything with a smaller value.

I can't find a countercase. An extremely long string or name won't be truncated even longer than 120. Long numerical expressions will be divided into parts as short as possible I guess? I can't tell the reason why a line is reformatted.

[ziyanx02]

The final version is

• Use pre-commit hooks to ensure you don’t forget to run checks.
• Suggesting to do local CI tests locally.