Skip to content

Commit

Permalink
move contribute docs into developer docs
Browse files Browse the repository at this point in the history
  • Loading branch information
biasmv committed Jun 28, 2015
1 parent 84e33c7 commit f298589
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 44 deletions.
44 changes: 0 additions & 44 deletions CONTRIBUTE.md

This file was deleted.

45 changes: 45 additions & 0 deletions doc/developer.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,51 @@
PV for developers documentation
=========================================

How to Contribute
-----------------------------------------

Contributions of any kind (code, documentation, bug reports) are more than welcome.

Coding conventions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Apart from the basic rules listed below, there is no detailed style guide. In doubt, just look at the existing code.

- always put braces around if/else/while/for statements.
- and indent is two spaces
- camelCase your variables and function names
- use an _ prefix for your private variables that should not be accessed from outside the class
- wrap code at 80 characters
- use === and !== for comparisons

Commits
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Use descriptive commit messages using the following format:

- a short single-line summary, e.g. "add transparency for mesh and line geoms". This line summary should not exceed 60-70 characters.
- optionally a block of text that describes the change in more detail, e.g.

color information is now stored as an RGBA quadruplet to accomodate one
alpha value for each vertex. Coloring operations have grown the ability to
specify alpha values. In case they are omitted, they default to 1.0
(fully opaque) structure.

the block should be wrapped at 80 characters.

In case you are submitting a larger feature/bugfix, split your work into multiple commits. The main advantage is that your change becomes easier to review.

Before submitting
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Before submitting, or sending the pull request

- make sure that there are no unrelated changes checked in.
- run grunt to check for any coding convention violations and in general make sure that grunt is still able to minify your code without problems.
- in case you are adding new functionality, make sure you area adding it to the API documentation



How to release a new version of PV
------------------------------------------

Expand Down

0 comments on commit f298589

Please sign in to comment.