https://github.com/jcfr/commit-message-collection
The open-source citizen commit message collection
https://github.com/jcfr/commit-message-collection
best-practices commit-message open-source
Last synced: 2 months ago
JSON representation
The open-source citizen commit message collection
- Host: GitHub
- URL: https://github.com/jcfr/commit-message-collection
- Owner: jcfr
- Created: 2017-10-21T19:33:10.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-10-21T21:52:38.000Z (over 7 years ago)
- Last Synced: 2025-01-24T10:24:32.884Z (4 months ago)
- Topics: best-practices, commit-message, open-source
- Size: 2.93 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
The open-source citizen commit message collection
=================================================
Collection of well crafted and informative commit messages used when
updating a project to follow the best practices.
> I created this collection of commit messages because I too often
> find myself browsing history of projects I worked on to copy-paste
> content of messages.
>
> -- @jcfr on Saturday, October 21, 2017
Contributions are welcome.
Table of Contents
=================
* [The open-source citizen commit message collection](#the-open-source-citizen-commit-message-collection)
* [Python](#python)
* [flake8](#flake8)
* [Use "is None" instead of "== None"](#use-is-none-instead-of--none)
[![][cc-img]][cc]
This work is licensed under a [Creative Commons Attribution 4.0 International License][cc].
[cc]: http://creativecommons.org/licenses/by/4.0/
[cc-img]: https://i.creativecommons.org/l/by/4.0/80x15.png
# Python
## flake8
```
STYLE: Add .flake8 configuration to support python script validation
Flake8 is a python source checker.
The initial configuration file adds exceptions for all errors, it will
iteratively be updated as the code is improved.
After installing flake8 with `pip install flake8`, the following shell
script was used to craft the list of exceptions:
IFS=$'\n'
for line in $(flake8 . | cut -d":" -f4 | sort | uniq)
do
# Remove leading space
line=$(echo $line | sed -e 's/^[ \t]*//')
# Extract error code
code=$(echo $line | cut -d" " -f1)
echo " # $line"
echo " $code,"
done
Internally flake8 is wrapper around these tools:
* PyFlakes: analyzes programs and detects various errors. It works by
parsing the source file, not importing it, so it is safe to use on
modules with side effects. It’s also much faster.
* pycodestyle: a tool to check your Python code against some of the
style conventions in PEP 8 (the style guide for python code).
See https://www.python.org/dev/peps/pep-0008/
* Ned Batchelder’s McCabe script: check McCabe (or cyclomatic) complexity.
See https://en.wikipedia.org/wiki/Cyclomatic_complexity.
To learn more about flake8. See http://flake8.pycqa.org/en/latest/
```
## Use "is None" instead of "== None"
```
STYLE: Update python scripts to use "is None" instead of "== None"
Rational copied from https://www.python.org/dev/peps/pep-0290/#testing-for-none
// -----------------
Since there is only one None object, equality can be tested with identity. Identity
tests are slightly faster than equality tests. Also, some object types may overload
comparison, so equality testing may be much slower.
Pattern:
if v == None --> if v is None:
if v != None --> if v is not None:
// -----------------
```