Skip to content

Commit 6f4f1b4

Browse files
committed
add contributing doc
1 parent 8b297ee commit 6f4f1b4

File tree

2 files changed

+38
-1
lines changed

2 files changed

+38
-1
lines changed

CONTRIBUTING.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Contributing to clusterProfiler development
2+
3+
1. Filing a bug report or feature request in an issue.
4+
1. Suggesting a change via a pull request.
5+
6+
## Issues
7+
8+
When filing an issue, the most important thing is to include a minimal reproducible example so that we can quickly verify the problem, and then figure out how to fix it. There are three things you need to include to make your example reproducible: required packages, data, code.
9+
10+
1. **Packages** should be loaded at the top of the script, so it's easy to
11+
see which ones the example needs.
12+
13+
1. The easiest way to include **data** is to use `dput()` to generate the R code
14+
to recreate it. For example, to recreate the `gene` vector/list in R,
15+
I'd perform the following steps:
16+
17+
1. Run `dput(gene)` in R
18+
2. Copy the output
19+
3. In my reproducible script, type `gene <- ` then paste.
20+
21+
22+
1. Spend a little bit of time ensuring that your **code** is easy for others to
23+
read:
24+
25+
* make sure you've used spaces and your variable names are concise, but
26+
informative
27+
28+
* use comments to indicate where your problem lies
29+
30+
* do your best to remove everything that is not related to the problem.
31+
The shorter your code is, the easier it is to understand.
32+
33+
You can check you have actually made a reproducible example by starting up a fresh R session and pasting your script in.
34+
35+
36+
## Pull requests
37+

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ To view the vignette of `clusterProfiler` installed in your system, start `R` an
9696
vignette("clusterProfiler", package="clusterProfiler")
9797
```
9898

99-
More documents can be found in <http://www.bioconductor.org/packages/DOSE>, <http://www.bioconductor.org/packages/clusterProfiler> and <http://guangchuangyu.github.io/tags/clusterprofiler>.
99+
More documents can be found in <http://www.bioconductor.org/packages/DOSE>, <http://www.bioconductor.org/packages/clusterProfiler> and <http://guangchuangyu.github.io/clusterProfiler>.
100100

101101

102102

0 commit comments

Comments
 (0)