Commit Graph

26 Commits

Author SHA1 Message Date
Andrew Leech 4679a90097 CODECONVENTIONS: Update for change from black to ruff format.
Also add notes on running pre-commit manually.

Signed-off-by: Andrew Leech <andrew@alelec.net>
2023-11-09 13:36:21 +11:00
Damien George 7c645b52e3 CODECONVENTIONS: Require that commits be signed-off by the author.
And use "must" instead of "should" where appropriate in related text.

Signed-off-by: Damien George <damien@micropython.org>
2023-05-08 12:20:56 +10:00
Damien George b1229efbd1 all: Fix spelling mistakes based on codespell check.
Signed-off-by: Damien George <damien@micropython.org>
2023-04-27 18:03:06 +10:00
Brian Pugh 0098096682 CODECONVENTIONS: Fix brew uncrustify installation instructions.
For security reasons, homebrew stopped allowing direct Formula references.

Signed-off-by: Brian Pugh <bnp117@gmail.com>
2023-03-02 23:10:00 +11:00
Angus Gratton 36347817ec CODECONVENTIONS: Explain uncrustify dependency for pre-commit setup.
pre-commit manages its own dependencies otherwise (including Black), but
this one is a C/C++ binary so needs to be installed independently.

Signed-off-by: Angus Gratton <angus@redyak.com.au>
2023-01-19 16:10:21 +11:00
Jim Mussared 4fc543c829 CODECONVENTIONS.md: Update pre-commit instructions.
Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
2022-10-11 17:47:05 +11:00
Angus Gratton 0e35c4de9b tools: Add pre-commit support.
Tweak the existing codeformat.py and verifygitlog.py to allow them to be
easily called by pre-commit.

(This turned out to be easier than using any existing pre-commit hooks,
without making subtle changes in the formatting.)

This work was funded through GitHub Sponsors.

Signed-off-by: Angus Gratton <angus@redyak.com.au>
2022-10-04 14:52:48 +11:00
Angus Gratton bdac8272d8 tools: Add note about uncrustify versions.
Uncrustify versions are not mutually compatible:

1. Version 0.73 or newer produce slightly different formatting. It may be
possible to tweak these by adding more config items, but this will cause
older versions to error out with 'Unknown option'.

2. Version 0.75 prints a range of deprecation warnings due to config file
changes, and returns a non-zero exit code. These are actually fixable
as most are the default value, and pp_indent has changed from 'true' to '1'
which is backwards compatible. However issue 1 remains, so probably better
to have it fail explicitly.

This work was funded through GitHub Sponsors.

Signed-off-by: Angus Gratton <angus@redyak.com.au>
2022-10-04 14:34:54 +11:00
Damien George 5093597542 top: Update contribution and commit guide to include optional sign-off.
MicroPython already requires contributors to implicitly sign-off on a set
of points, which are listed in CODECONVENTIONS.md.

This commit adjusts this wording to allow explicit sign-off using the git
"Signed-off-by:" feature.  There is no reference made to
https://developercertificate.org/ because the project already has its own
version of this.

Signed-off-by: Damien George <damien@micropython.org>
2020-06-12 13:32:22 +10:00
Damien George 54a54f5872 CODECONVENTIONS.md: Update to reflect use of new tools/codeformat.py. 2020-02-28 12:35:19 +11:00
Damien George 761e4c7ff6 all: Remove trailing spaces, per coding conventions. 2017-07-19 13:12:10 +10:00
Paul Sokolovsky 176aa681f0 CODECONVENTIONS: docs: Markup for None/True/False.
Based on what CPython uses. However, Read The Docs theme styles this
markup in very stand-out way, so we may think what to do about it.
2017-06-25 00:26:44 +03:00
Paul Sokolovsky e92602ba27 CODECONVENTIONS: Start to describe docs conventions. 2017-06-25 00:13:13 +03:00
Paul Sokolovsky b8fef67c69 CODECONVENTIONS: Clarify MicroPython changes sign-off process.
In particular, require the real name and email address.
2017-06-16 11:32:51 +03:00
Paul Sokolovsky 299c0a3925 CODECONVENTIONS: Typo fix. 2017-05-21 15:58:03 +03:00
Paul Sokolovsky cea1c621e0 CODECONVENTIONS.md: Describe git commit messages conventions. 2016-05-07 22:32:13 +03:00
Damien George 0334058fa4 Rename "Micro Python" to "MicroPython" in REPL, help, readme's and misc. 2015-10-12 00:06:25 +01:00
Damien George d136737872 CODECONVENTIONS: Add a short section about how to allocate heap memory. 2015-07-20 12:18:16 +01:00
Garrett Berg f64e080d9a CODECONVENTIONS.md: add documentation on putting comments in code. 2015-06-25 10:56:39 +01:00
Damien George 3299f687f5 CODECONVENTIONS.md: Mention macro and enum names. 2015-06-24 17:35:27 +01:00
stijn 9c7d183a94 CODECONVENTIONS.md: Add function/variable/argument naming convention 2015-06-24 17:35:27 +01:00
Paul Sokolovsky b85bf25e97 CODECONVENTIONS.md: 16-bit ports exist now. 2015-06-18 11:40:48 +03:00
Paul Sokolovsky 2474c2ae94 CODECONVENTIONS.md: Header files no longer follow Plan 9 conventions. 2015-06-18 11:38:09 +03:00
Damien George 16ef60fba6 Updated CODECONVENTIONS to clarify use of integer types. 2014-09-25 15:49:26 +01:00
Damien George 90ac822097 Add Python code conventions to CODECONVENTIONS. 2014-04-18 12:46:46 +01:00
Damien 7f7636e41c Add CODECONVENTIONS, and modify i2c module to conform. 2013-12-29 12:12:25 +00:00