Contributing guide

Hello fellow developer/hacker/citizen/peer!

The uData project welcomes, and depends, on contributions from developers and users in the open source community. Contributions can be made in a number of ways, a few examples are:

  • Code patches via pull requests
  • Documentation improvements
  • Bug reports and patch reviews

We welcome improvements from developers of all skill levels.

Ethics

This project operates under the W3C’s Code of Ethics and Professional Conduct:

W3C is a growing and global community where participants choose to work together, and in that process experience differences in language, location, nationality, and experience. In such a diverse environment, misunderstandings and disagreements happen, which in most cases can be resolved informally. In rare cases, however, behavior can intimidate, harass, or otherwise disrupt one or more people in the community, which W3C will not tolerate.

A Code of Ethics and Professional Conduct is useful to define accepted and acceptable behaviors and to promote high standards of professional practice. It also provides a benchmark for self evaluation and acts as a vehicle for better identity of the organization.

We hope that our community group act according to these guidelines, and that participants hold each other to these high standards. If you have any questions or are worried that the code isn’t being followed, please contact the owner of the repository.

Language

The development language is English. All comments and documentation should be written in English, so that we don’t end up with “frenghish” methods, and so we can share our learnings with developers around the world.

Process

We’re really happy to accept contributions from the community, that’s the main reason why we open-sourced it! There are many ways to contribute, even if you’re not a technical person.

We’re using the infamous simplified Github workflow to accept modifications (even internally), basically you’ll have to:

  • create an issue related to the problem you want to fix (good for traceability and cross-reference)
  • fork the repository
  • create a branch (optionally with the reference to the issue in the name)
  • hack hack hack
  • commit incrementally with readable and detailed commit messages
  • add the change to the CHANGELOG.md file if appropriated
  • submit a pull-request against the right branch of this repository:
    • dev for new features
    • master for bugfixes (unless only present in dev)

We’ll take care of tagging your issue with the appropriated labels and answer within a week (hopefully less!) to the problem you encounter.

If you’re not familiar with open-source workflows or our set of technologies, do not hesitate to ask for help! We can mentor you or propose good first bugs.

Discussing strategies

We’re trying to develop this project in the open as much as possible. We have a dedicated Gitter channel where we discuss each new strategic change and invite the community to give a valuable feedback. You’re encouraged to join and participate.

We also vote for new features in order to include the whole community in the process.

Code guides

Python style guide

We follow the PEP-0008 and PEP-0257 as mush as possible in the respect of PEP-0020.

On top of that, we apply the Python Style Guide from Google.

Python 3 forward compatible syntax

As it’s still planned to migrate to Python 3 some day, try to always use a forward compatible syntax in order to ensure an easy future migration:

  • unicode by default, starts any file with from __future__ import unicode_literals
  • Python 3 compatible print statement with from __future__ import print_function
  • use io.open instead of codecs.open to manipulate utf-8 files

JavaScript style guide

We follow the JavaScript styleguide from airbnb.

HTML and CSS code guide

We follow @mdo’s code guide.

Documentation syntax

We try to stay as close as possible to CommonMark but use default extensions proposed by MkDocs.