Skip to content

Commit 6a8be41

Browse files
abmussejkdavew
authored andcommitted
Add contribution guidelines (IBM#37)
* Add contribution guidelines * Update README.md - Add link to contribution guidelines * Add dco bot config - ignores members of the org from signing off * Add .npmignore - Added to ignore .github and other files from npm package Signed-off-by: Dave Weissman <[email protected]>
1 parent 3cdccd6 commit 6a8be41

File tree

4 files changed

+79
-2
lines changed

4 files changed

+79
-2
lines changed

.github/dco.yml

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
require:
2+
members: false

.npmignore

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.github/
2+
CONTRIBUTING.md
3+
test/rpg/

CONTRIBUTING.md

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
## Contributing In General
2+
Our project welcomes external contributions. If you have an itch, please feel
3+
free to scratch it.
4+
5+
To contribute code or documentation, please submit a [pull request](https://github.com/IBM/nodejs-itoolkit/pulls).
6+
7+
A good way to familiarize yourself with the codebase and contribution process is
8+
to look for and tackle low-hanging fruit in the [issue tracker](https://github.com/IBM/nodejs-itoolkit/issues).
9+
10+
**Note: We appreciate your effort, and want to avoid a situation where a contribution
11+
requires extensive rework (by you or by us), sits in backlog for a long time, or
12+
cannot be accepted at all!**
13+
14+
### Proposing new features
15+
16+
If you would like to implement a new feature, please [raise an issue](https://github.com/IBM/nodejs-itoolkit/issues)
17+
before sending a pull request so the feature can be discussed. This is to avoid
18+
you wasting your valuable time working on a feature that the project developers
19+
are not interested in accepting into the code base.
20+
21+
### Fixing bugs
22+
23+
If you would like to fix a bug, please [raise an issue](https://github.com/IBM/nodejs-itoolkit/issues) before sending a
24+
pull request so it can be tracked.
25+
26+
27+
## Legal
28+
29+
We have tried to make it as easy as possible to make contributions. This
30+
applies to how we handle the legal aspects of contribution. We use the
31+
same approach - the [Developer's Certificate of Origin 1.1 (DCO)](https://github.com/hyperledger/fabric/blob/master/docs/source/DCO1.1.txt) - that the Linux® Kernel [community](https://elinux.org/Developer_Certificate_Of_Origin)
32+
uses to manage code contributions.
33+
34+
We simply ask that when submitting a patch for review, the developer
35+
must include a sign-off statement in the commit message.
36+
37+
Here is an example Signed-off-by line, which indicates that the
38+
submitter accepts the DCO:
39+
40+
```
41+
Signed-off-by: John Doe <[email protected]>
42+
```
43+
44+
You can include this automatically when you commit a change to your
45+
local git repository using the following command:
46+
47+
```
48+
git commit -s
49+
```
50+
51+
## Communication
52+
Please feel free to connect with us on our [Ryver forum](https://ibmioss.ryver.com/index.html#forums/1000127).
53+
54+
You can join the Ryver community [here](https://ibmioss.ryver.com/application/signup/members/9tJsXDG7_iSSi1Q).
55+
56+
## Setup
57+
Ensure that all dependencies are installed.
58+
59+
From the root of the project directory run:
60+
61+
`npm install`
62+
63+
## Testing
64+
This project uses mocha for its tests.
65+
66+
For more information on how to test view the [README](https://github.com/IBM/nodejs-itoolkit/blob/master/test/README.md)
67+
68+
## Coding style guidelines
69+
This project uses eslint and [airbnb style guide](https://github.com/airbnb/javascript) to enforce common code style.
70+
71+
New contributions should also follow these guidelines.

README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,8 @@ Installation is done from a PASE shell.
7777
* https://www.ibm.com/developerworks/community/wikis/home?lang=en#!/wiki/IBM%20i%20Technology%20Updates/page/Toolkit%20for%20i%20APIs
7878

7979
# Contributions
80-
If you would like to contribute please issue a pull request. No document signing is necessary for this code base.
80+
Please read the [contribution guidelines](https://github.com/IBM/nodejs-itoolkit/blob/master/CONTRIBUTING.md).
81+
8182

8283
# License
83-
MIT. View [`LICENSE`](https://github.com/IBM/nodejs-itoolkit/blob/master/LICENSE) file.
84+
[`MIT`](https://github.com/IBM/nodejs-itoolkit/blob/master/LICENSE) file.

0 commit comments

Comments
 (0)