style changes
parent
8a44431d5a
commit
4d18ef885f
|
@ -4,16 +4,28 @@ The following is a few and guidelines regarding the current philosophy, style,
|
|||
flaws, and the future directions of svgpathtools. These guidelines are meant
|
||||
to make it easy to contribute.
|
||||
|
||||
## Basic Considerations
|
||||
## Being a Hero
|
||||
We need better automated testing coverage. Please, submit unittests! See the
|
||||
Testing Style section below for info.
|
||||
|
||||
### New features should come with unittests and docstrings.
|
||||
Here's a list of things that need (more) unittests
|
||||
* OK, well... maybe you could help by filling out this list
|
||||
|
||||
## Submitting Bugs
|
||||
If you find a bug, please submit an issue along with an **easily reproducible
|
||||
example**. Feel free to make a pull-request too (see relevant section below).
|
||||
|
||||
|
||||
## Submitting Pull-Requests
|
||||
|
||||
#### New features should come with unittests and docstrings.
|
||||
If you want to add a cool/useful feature to svgpathtools, that's great! Just
|
||||
make sure your pull-request includes both thorough unittests and well-written
|
||||
docstrings. See relevant sections below on "Testing Style" and
|
||||
"Docstring Style" below.
|
||||
|
||||
|
||||
### Modifications to old code may require additional unittests.
|
||||
#### Modifications to old code may require additional unittests.
|
||||
Certain submodules of svgpathtools are poorly covered by the current set of
|
||||
unittests. That said, most functionality in svgpathtools has been tested quite
|
||||
a bit through use.
|
||||
|
@ -23,6 +35,7 @@ unittests designed to verify that any affected functionary still works.
|
|||
|
||||
|
||||
## Style
|
||||
|
||||
### Coding Style
|
||||
* Follow the PEP8 guidelines unless you have good reason to violate them (e.g.
|
||||
you want your code's variable names to match some official documentation, or
|
||||
|
@ -38,7 +51,8 @@ appropriate option (e.g. "tau").
|
|||
|
||||
|
||||
### Testing Style
|
||||
See the svgpathtools/test folder for examples.
|
||||
You want to submit unittests?! Yes! Please see the svgpathtools/test folder
|
||||
for examples.
|
||||
|
||||
|
||||
### Docstring Style
|
||||
|
@ -47,4 +61,4 @@ Style Guide. Currently, this is not the case... but for the sake of
|
|||
consistency, Google Style is the officially preferred docstring style of
|
||||
svgpathtools.
|
||||
[Some nice examples of Google Python Style docstrings](
|
||||
https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html)
|
||||
https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html)
|
||||
|
|
Loading…
Reference in New Issue