GitHub/Anki
1
0
Fork 0
mirror of https://github.com/ankitects/anki.git synced 2025-09-18 22:12:21 -04:00
Code Issues Projects Releases Packages 1 Wiki Activity Actions

update contrib docs

Browse source
This commit is contained in:
Damien Elmes 2019-12-23 11:38:58 +10:00
parent a0ca95a414
commit 2d68544d64
1 changed files with 10 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.contributing
View file

@ -71,12 +71,6 @@ import the types from each module into the other one, as it can cause a cyclic
import. An example of how to work around this can be seen at import. An example of how to work around this can be seen at
https://github.com/dae/anki/commit/ed0b3d337458d7161811547932b6476f2d4bc887 https://github.com/dae/anki/commit/ed0b3d337458d7161811547932b6476f2d4bc887
Maintaining Style
------------------
For consistency, changes should maintain the existing code style - camelCaps,
<80 column lines, succinct variable names and so on.
Tests Must Pass Tests Must Pass
---------------- ----------------
@ -85,6 +79,16 @@ Please make sure 'make check' completes successfully before submitting code.
If your change is to anki/ and not covered by the existing unit tests, please If your change is to anki/ and not covered by the existing unit tests, please
consider adding a unit test at the same time. consider adding a unit test at the same time.
Code Style
------------------
You are welcome to use snake_case variable names and functions in newly
introduced code, but please avoid renaming existing variables and functions
that use camelCaps.
If your code isn't formatted correctly, 'make check' will report problems.
You can fix the formatting automatically with 'make fixpyfmt'.
Do One Thing Do One Thing
------------- -------------