This repository has been archived by the owner on Sep 15, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 11
/
CONTRIBUTING.rst
79 lines (56 loc) · 3.1 KB
/
CONTRIBUTING.rst
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
How to contribute
===================================
First of all, thank you for contributing!
The mailing list
----------------
For general questions or if you are having trouble getting started, try the
`Google Genomics Discuss mailing list <https://groups.google.com/forum/#!forum/google-genomics-discuss>`_.
It's a good way to sync up with other people who use googlegenomics including the core developers. You can subscribe
by sending an email to ``google-genomics-discuss+subscribe@googlegroups.com`` or just post using
the `web forum page <https://groups.google.com/forum/#!forum/google-genomics-discuss>`_.
Local development
-----------------
With Maven you can locally install a SNAPSHOT version of the code, to use from other projects
directly without having to wait for the Maven repository. Use:
````
mvn install
````
to run the full tests and do a local install. You can also use
````
mvn install -DskipITs
````
to run only the unit tests and do a local install. This is faster.
Submitting issues
-----------------
If you are encountering a bug in the code or have a feature request in mind - file away!
Submitting a pull request
-------------------------
If you are ready to contribute code, Github provides a nice `overview on how to create a pull request
<https://help.github.com/articles/creating-a-pull-request>`_.
Some general rules to follow:
* Do your work in `a fork <https://help.github.com/articles/fork-a-repo>`_ of this repo.
* Create a branch for each update that you're working on.
These branches are often called "feature" or "topic" branches. Any changes
that you push to your feature branch will automatically be shown in the pull request.
* Keep your pull requests as small as possible. Large pull requests are hard to review.
Try to break up your changes into self-contained and incremental pull requests.
* The first line of commit messages should be a short (<80 character) summary,
followed by an empty line and then any details that you want to share about the commit.
* Please try to follow the existing syntax style
When you submit or change your pull request, the Travis build system will automatically run tests.
If your pull request fails to pass tests, review the test log, make changes and
then push them to your feature branch to be tested again.
Contributor License Agreements
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
All pull requests are welcome. Before we can submit them though, there is a legal hurdle we have to jump.
You'll need to fill out either the individual or corporate Contributor License Agreement
(CLA).
* If you are an individual writing original source code and you're sure you
own the intellectual property, then you'll need to sign an `individual CLA
<https://developers.google.com/open-source/cla/individual>`_.
* If you work for a company that wants to allow you to contribute your work,
then you'll need to sign a `corporate CLA
<https://developers.google.com/open-source/cla/corporate>`_.
Follow either of the two links above to access the appropriate CLA and
instructions for how to sign and return it. Once we receive it, we'll be able to
accept your pull requests.