We love contributions from outside our organization. If you would like to contribute, please do the following:
- Fork our repository on Github
- If you're taking on one of the issues, look for ones labeled 'bite-sized' as a good starter issue.
- Make a feature branch and commit your changes there. Note any milestone for the feature.
- Issue a pull request against the master branch, or a milestone target (typically r/X.Y.Z where X.Y.Z matches the milestone in the issue, if applicable)
- Once you've issued a request, we'll review your changes, comment and merge them once we've had a chance to test.
We use PEP8 for our coding standard. Note, much of our older code is non PEP8 compliant; the goal is to update to PEP8 as we touch those areas.
For class and method documentation, use reStructuredText http://docutils.sourceforge.net/rst.html
Example:
"""Documentation for function
:param var_name: :type var_name: """
Always ensure that the file header at the top of the file matches the following block. If it doesn't, please fix it as part of your patch.
#
# Race Capture App
#
# Copyright (C) 2014-2016 Autosport Labs
#
# This file is part of the Race Capture App
#
# This is free software: you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This software is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
#
# See the GNU General Public License for more details. You should
#have received a copy of the GNU General Public License along with
#this code. If not, see <http://www.gnu.org/licenses/>.