Skip to content

Commit

Permalink
#21 start dev guide
Browse files Browse the repository at this point in the history
  • Loading branch information
drofp committed Jul 5, 2018
1 parent 0087c30 commit cb6b474
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/standards/git/git_dev_guide.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
###==== FusionAD Git Dev Guide ====###
2 changes: 2 additions & 0 deletions docs/standards/ros/ros_style_guide.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
###==== FusionAD ROS Dev Guide ====###

33 changes: 33 additions & 0 deletions docs/standards/style/python_style_guide.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
###==== FusionAD Python Style Guide ====###
NOTE: If not explicitly stated in this guide, defer to PEP 8 standard

==========
==Naming==
==========
- Modules - Snake Case
example: some_random_module

- Classes - Pascal Case
example: SomeRandomClass

- Methods - Snake Case
example: some_random_method

- Variables - Camel Case
example: someRandomVariable

==============
==Docstrings==
==============
- Unless otherwise specified, docstring format should follow numpy docstring format, as specified in numpydoc v0.9.dev0 Manual.

- All modules, classes, and methods shall include at minimum a short summary, parameters section, and returns section. Exceptions to this rule is stated below
- All modules, classes, and methods under 10 lines may include only the short summary
- All trivial modules, classes, and methods may omit docstrings, at discretion of developer, provided that self-explanatory naming is utilized.

===================
==Important Notes==
===================
- Use ```from __future__ import division``` in accordance with PEP 238
- Use ```#!/usr/bin/env python``` for shebang lines when applicable

0 comments on commit cb6b474

Please sign in to comment.