ipng/vppcfg
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add a note about black code formatting

Browse Source
This commit is contained in:
Pim van Pelt
2022-04-22 13:13:42 +00:00
parent b7ff5479ac
commit f8a6c3eba7
1 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/contributing.md
View File

@ -23,6 +23,9 @@ small guidelines you need to follow.
1. Do your best to have well-formed commit messages for each change. This provides consistency 1. Do your best to have well-formed commit messages for each change. This provides consistency
throughout the project, and ensures that commit messages are able to be formatted properly throughout the project, and ensures that commit messages are able to be formatted properly
by various git tools. by various git tools.
1. Code will be checked for Python formatting by [black](https://github.com/psf/black) so before
submitting a pull request (or pushing), ensure `black . vppcfg` is run and changes are accounted
for.
Finally, push the commits to your fork and submit a pull request (GitHub) or commit them to Finally, push the commits to your fork and submit a pull request (GitHub) or commit them to
gerrit.fd.io and request a review (Gerrit). gerrit.fd.io and request a review (Gerrit).