summaryrefslogtreecommitdiffstats
path: root/SUBMITTING_PATCHES.md
Commit message (Collapse)AuthorAgeFilesLines
* docs: add deprecated branch bannerHEADmasterMike Frysinger2024-01-041-0/+3
| | | | | | | | | | The master branch is dead. Add banners to all the docs in case people try referring to these and don't realize they're on the wrong branch. Change-Id: I3488d0d96df25fafd7285848fe9f519b4205519c Reviewed-on: https://gerrit-review.googlesource.com/c/git-repo/+/400918 Tested-by: Mike Frysinger <vapier@google.com> Reviewed-by: Josip Sokcevic <sokcevic@google.com>
* Reword the documentation regarding coding styleDavid Pursehouse2020-02-151-22/+13
| | | | | | | | | | | | | | | | | | | | | - flake8 is a wrapper around pyflakes, so it's redundant to mention both of them. Roll the explicit sections about coding errors and coding style violations into a single section. - After recent cleanups the project now has zero warnings or errors from flake8. Reword the requirements so that it is now mandatory to not introduce new warnings. - Expand the section on suppression of warnings to differentiate between suppressing inline individually and globally suppressing for the whole project. - Properly capitalize "Python Style Guide". Change-Id: I4b333d013e985db252873441b16cb719ed5be5b5 Reviewed-on: https://gerrit-review.googlesource.com/c/git-repo/+/255040 Tested-by: David Pursehouse <dpursehouse@collab.net> Reviewed-by: Mike Frysinger <vapier@google.com>
* Mention exceptions to Google Style Guide in SUBMITTING_PATCHES.mdDavid Pursehouse2020-02-131-3/+8
| | | | | | | Change-Id: I05d313c66f312942405a884a54118cb1d7af1bac Reviewed-on: https://gerrit-review.googlesource.com/c/git-repo/+/254671 Tested-by: David Pursehouse <dpursehouse@collab.net> Reviewed-by: Mike Frysinger <vapier@google.com>
* tox: add & document tox usageMike Frysinger2019-12-021-3/+31
| | | | | | | | | | This makes it easy to run all the tests against multiple versions of Python. We want to make sure Python 2.7 & 3.6+ work. Change-Id: Ia7b16eb46a2aa7c240f03bb291987fa8cb215267 Reviewed-on: https://gerrit-review.googlesource.com/c/git-repo/+/247174 Reviewed-by: David Pursehouse <dpursehouse@collab.net> Tested-by: Mike Frysinger <vapier@google.com>
* run_tests: add a helper for invoking unittestsMike Frysinger2019-07-111-6/+20
| | | | | | | | | | | This makes it very easy for people to run all our unittests with just `./run_tests`. There doesn't seem to be any other way currently to quickly invoke any of the tests. Change-Id: I1f9a3745fa397a1e797bd64065c2ba7f338de4a1 Reviewed-on: https://gerrit-review.googlesource.com/c/git-repo/+/227613 Tested-by: David Pursehouse <dpursehouse@collab.net> Reviewed-by: David Pursehouse <dpursehouse@collab.net>
* Replace pylint with pyflakes/flake8David Pursehouse2016-09-141-4/+24
| | | | | | | | | | | | | | | | | | | | | | | pylint reports a lot of warnings, but many of them are false positive, and it's difficult to configure it. It also seems that for some reason the included config file is not working well with the latest version. Update the documentation to recommend using pyflakes and flake8 instead of pylint. Remove the pylint config and add a basic flake8 config with minimum settings: - Maximum line length 80 columns - Ignore warnings about indentation (repo uses 2 rather than expected 4) - Ignore warnings about import placement In this commit no code cleanup is done, and it's expected that most of the files will throw up quite a few warnings, at least for flake8. These can be cleaned up in follow-up commits. The existing pylint suppression comments are left as-is. These will be helpful when cleaning up pyflakes warnings later. Change-Id: I2f7cb4340266ed07cc973ca6483b8f09d66a765b
* improve docsMike Frysinger2016-08-161-0/+115
Change-Id: Ide4008f09c2f17f8fb3d85dfffe94544abfdd6a6