1. mzR
  2. CONTRIBUTIONS.md
Browse code

update contributions file

Laurent authored on 22/08/2017 16:39:13
Showing 1 changed files
CONTRIBUTIONS.md
History View file @ aa74dce29e
... ... 
@@ -1,28 +1,35 @@
1 1 
 # Contributing to `mzR`
2 2
3 3 
 We welcome contributions from everybody, including bug fixes, new
4 
-features, improvements on the documentation, and general
5 
-suggestions.
4 
+features, improvements on the documentation, and general suggestions.
6 5
7 
-Here are some pieces of advice and
6 
+Here are some pieces of advice and suggestions:
8 7
9 
-* Make the updates a small and contained as possible, possibly under
10 
-  different Github commits, to facilitate the code review. Don't
11 
-  hesitate to use the Github code review.
8 
+* We recommend to discuss changes and contributions in a Github issue,
9 
+ in particular when these are substantial.
12 10
13 
-* Follow the coding style used in the package.
11 
+* Check in the
12 
+ current [Github issues](https://github.com/sneumann/mzR/issues) to
13 
+ see if a similar issue is already discussed, and join efforts.
14 14
15 
-* Check in the current [Github
16 
-  issues](https://github.com/sneumann/mzR/issues) to see if your
17 
-  contribution or a similar issue is not already discussed.
15 
+* Make the updates as small and contained as possible, possibly under
16 
+ different Github commits, to facilitate the code review. Don't
17 
+ hesitate to use the Github code review.
18 18
19 
-* Assure that `mzR` builds and check on Linux, Windows and OSX. Don't
20 
-  hesitate to get in touch if you don't have access on all platforms.
19 
+* Follow the coding style used in the package. See also the
20 
+  Bioconductor coding
21 
+  style
22 
+  [here](https://bioconductor.org/developers/how-to/coding-style/).
21 23
22 
-* If relevant, also update the documentation (man pages and/or
23 
-  vignette) to make sure users are aware of the changes.
24 
+* Ideally, add a unit test that checks the new code, examples are in
25 
+  `mzR/inst/unitTests`.
26 
+
27 
+* Please avoid platform specific code to assure that `mzR` builds and
28 
+  checks Linux, Windows and OSX. Pull requests will also be checked by
29 
+  https://travis-ci.org/sneumann/mzR/
24 30
25 
-* Ideally, add a unit test that checks the new code.
31 
+* Make sure to also update the documentation (man pages and/or
32 
+  vignette) to make sure users are aware of the changes.
26 33
27 34 
 * If your change is visible to users (new features, bug fix, updated
28 35 
   documentation, ...) update the `NEWS` file.
Browse code

Add contributions guide with code of conduct

Laurent authored on 22/08/2017 13:32:37
Showing 1 changed files
CONTRIBUTIONS.md
History View file @ c8f01efb2c
1 1 
new file mode 100644
... ... 
@@ -0,0 +1,62 @@
1 
+# Contributing to `mzR`
2 
+
3 
+We welcome contributions from everybody, including bug fixes, new
4 
+features, improvements on the documentation, and general
5 
+suggestions.
6 
+
7 
+Here are some pieces of advice and
8 
+
9 
+* Make the updates a small and contained as possible, possibly under
10 
+  different Github commits, to facilitate the code review. Don't
11 
+  hesitate to use the Github code review.
12 
+
13 
+* Follow the coding style used in the package.
14 
+
15 
+* Check in the current [Github
16 
+  issues](https://github.com/sneumann/mzR/issues) to see if your
17 
+  contribution or a similar issue is not already discussed.
18 
+
19 
+* Assure that `mzR` builds and check on Linux, Windows and OSX. Don't
20 
+  hesitate to get in touch if you don't have access on all platforms.
21 
+
22 
+* If relevant, also update the documentation (man pages and/or
23 
+  vignette) to make sure users are aware of the changes.
24 
+
25 
+* Ideally, add a unit test that checks the new code.
26 
+
27 
+* If your change is visible to users (new features, bug fix, updated
28 
+  documentation, ...) update the `NEWS` file.
29 
+
30 
+Before sending a pull request, we advice to discuss the changes in a
31 
+Github issue, in particular when these are substantial.
32 
+
33 
+### Contributor Code of Conduct
34 
+
35 
+As contributors and maintainers of this project, we pledge to respect
36 
+all people who contribute through reporting issues, posting feature
37 
+requests, updating documentation, submitting pull requests or patches,
38 
+and other activities.
39 
+
40 
+We are committed to making participation in this project a
41 
+harassment-free experience for everyone, regardless of level of
42 
+experience, gender, gender identity and expression, sexual
43 
+orientation, disability, personal appearance, body size, race,
44 
+ethnicity, age, or religion.
45 
+
46 
+Examples of unacceptable behaviour by participants include the use of
47 
+sexual language or imagery, derogatory comments or personal attacks,
48 
+trolling, public or private harassment, insults, or other
49 
+unprofessional conduct.
50 
+
51 
+Project maintainers have the right and responsibility to remove, edit,
52 
+or reject comments, commits, code, wiki edits, issues, and other
53 
+contributions that are not aligned to this Code of Conduct. Project
54 
+maintainers who do not follow the Code of Conduct may be removed from
55 
+the project team.
56 
+
57 
+Instances of abusive, harassing, or otherwise unacceptable behaviour
58 
+may be reported by opening an issue or contacting one or more of the
59 
+project maintainers.
60 
+
61 
+This Code of Conduct is adapted from the Contributor Covenant, version
62 
+1.0.0, available from http://contributor-covenant.org/version/1/0/0/