-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Closed
Description
Extra detail could be added to CONTRIBUTING.md so that new contributors will be aware of the process and coding style. Some suggestions:
- The preferred flow is that contributors fork the project and open a pull request from there, rather than creating a branch.
- Code style should follow the Google Python Style Guide
- Use an indentation of 2 spaces for blocks, and 4 spaces for line continuation.
- Use PascalCase for function and method names.
- Use parentheses around return tuples (this is notably a divergence from the Google guide, and may be changed).
- Do not use PEP 484 style type hints, to preserve compatibility with Python versions < 3.5
- Use single quotes around strings, and three double quotes around docstrings.
- Run tests by installing pytest, mock, termcolor, and hypothesis, then opening a bash terminal in the root of the repository and running
pytest.- Do this with both a Python 2 and 3 interpreter, the more versions the better.
- Lint your code by installing pylint, opening a bash terminal in the root of the repository and running
pylint fire. Ensure that the new code is not flagged up.- Do this with both a Python 2 and 3 interpreter.
I am happy to take on this task once there has been some discussion.
- What other detail would be useful?
- Is there a continuous integration process that makes the suggestion to test with multiply Python versions redundant?
Cheers,
Michael
Metadata
Metadata
Assignees
Labels
No labels