More instructions in contributing guide regarding formatting #4536
Conversation
NicolasHug
changed the title
| Feel free to read the [pre-commit docs](https://pre-commit.com/#usage) to learn | ||
| more and improve your workflow. You'll see for example that `pre-commit run | ||
| --all-files` will run both `ufmt` and `flake8` without the need for you to | ||
| commit anything, and that the `--no-verify` flag can be added to `git commit` to | ||
| temporarily deactivate the hooks. |
There was a problem hiding this comment.
I would think that someone who wants to know more about the tools they are using to do that without extra instructions. Given that we only describe how to format / check the code here, I think this can be safely removed. No strong opinion.
There was a problem hiding this comment.
For this part, I mostly wanted to mention the pre-commit run --all-files command and the --no-verify flag, which I think are important to know for regular development.
Then it becomes a matter of linking to the docs or not, I feel like there's no harm in encouraging contributors to check them?
|
Thanks @pmeier for the review. Is it good to go on your side? @fmassa @datumbox @prabhat00155 do these instructions make sense? Is there anything you think is missing or unclear? |
…#4536) Summary: * Enhanced contributing guide * Some more * Address comments Reviewed By: NicolasHug Differential Revision: D31505563 fbshipit-source-id: f791d8115c1d88a7b4e3bb4736f4eac8faf44f0b
…#4536) * Enhanced contributing guide * Some more * Address comments
…#4536) * Enhanced contributing guide * Some more * Address comments
5 participants
LMK what you think @pmeier