CONTRIBUTING.md 3.82 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
# Contributing

By contributing you agree to the [LICENSE](LICENSE) of this repository.

By contributing you agree to respect the [Code of Conduct](http://todogroup.org/opencodeofconduct/) of this repository.


## Issue Tracker

- before submitting a new issue, please:

    - check for existing related issues

    - check the issue tracker for a specific upstream project that may be more appropriate

    - check against supported versions of this project (i.e. the latest)

- please comment with a "+1" to help vote for issues that are important to you

- please DO NOT comment with a "+1", use the Subscribe button instead

- please keep discussions on-topic, and respect the opinions of others

- please report urgent issues, or issues with confidential details, via our commercial support channels


### Security Vulnerabilities

- please contact us privately to discuss security vulnerabilities as part of our [responsible disclosure](https://en.wikipedia.org/wiki/Responsible_disclosure) approach


### Bug Reports

- please report bugs in the issue tracker

- ideally provide a [reduced test case](https://css-tricks.com/reduced-test-cases/) and a live example on http://codepen.io/ , http://jsbin.com/ , https://jsfiddle.net/ , or similar

- please provide detailed steps to reproduce


### Feature Requests

- please suggest new features and improvements in the issue tracker

- suggestions for new features and improvements belong in Get Satisfaction


### Personal Support Requests

- requests for help are welcome in the issue tracker

- requests for help belong on Stack Overflow, Gitter, Slack or IRC

- please submit requests for help via our commercial support channels

- requests for help in the issue tracker receive lower priority than commercial support requests


## Pull Requests / Merge Requests

- please explicitly sign our Contributor License Agreement before submitting code for review and inclusion

- by submitting code for review and inclusion, we assume you have read and agree to our Contributor License Agreement

- **IMPORTANT**: by submitting a patch, you agree to allow the project owners to license your work under our this [LICENSE](LICENSE)

- please do not submit code for review and inclusion here

- provide tests for all features or bug fixes

- provide documentation for all public API methods

- Pull / Merge Request descriptions should include a change summary that matches the [Keep a CHANGELOG](http://keepachangelog.com/) format

- this project uses the [Git Flow](http://nvie.com/posts/a-successful-git-branching-model/) branching scheme, so changes should target the "develop" branch

- this project uses the [GitHub Flow](https://guides.github.com/introduction/flow/) branching scheme, so changes should target the "master" branch

- this project uses the [GitLab Flow](https://about.gitlab.com/2014/09/29/gitlab-flow/) branching scheme, so changes should target the "master" branch

- this project uses Atlassian's [Simple Git](http://blogs.atlassian.com/2014/01/simple-git-workflow-simple/) branching scheme, so changes should target the "master" branch

- please squash your commits if there is more than one

- feel free to submit un-squashed commits provided tests pass for all commits

- feel free to submit un-squashed commits


## Code Style and Code Quality

- adhere to our code style guides

- Python
  - http://wiki.ros.org/CppStyleGuide
-Django
  - https://docs.djangoproject.com/es/1.9/internals/contributing/writing-code/coding-style/

## Version Control

- this project adheres to [Semantic Versioning](http://semver.org/)

    - ideally, highlight when work would change the API surface in ways that break compatibility with existing consumers

- compose meaningful version control comments: http://alistapart.com/article/the-art-of-the-commit


## Development


### Prerequisites

__coming soon__


### Getting Started

__coming soon__