Skip to content

Commit 8510ec8

Browse files
authored
Merge pull request #100 from IBM/bump-deps
patch: bump deps and update contributor guide
2 parents a1ccae1 + 9e1f848 commit 8510ec8

File tree

6 files changed

+317
-2087
lines changed

6 files changed

+317
-2087
lines changed

CONTRIBUTING.md

Lines changed: 69 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,6 @@
33
Our project welcomes external contributions. If you have an itch, please feel
44
free to scratch it.
55

6-
It should also be noted that **[core-dump-handler](https://github.com/IBM/core-dump-handler/) is an [_OPEN Open Source Projects_](https://openopensource.org/).**
7-
8-
Individuals making significant and valuable contributions are given commit-access to a project to contribute as they see fit. A project is more like an open wiki than a standard guarded open source project.
9-
106
To contribute minor code or documentation, please submit a [pull request](https://github.com/ibm/core-dump-handler/pulls).
117

128
A good way to familiarize yourself with the codebase and contribution process is
@@ -17,6 +13,73 @@ Before embarking on a more ambitious contribution, please quickly [get in touch]
1713
requires extensive rework (by you or by us), sits in backlog for a long time, or
1814
cannot be accepted at all!**
1915

16+
## Setup
17+
18+
This project is based on Rust - The easiest way to get setup is to us the [rustup install system](https://rustup.rs/).
19+
20+
To perform an end to end integration test you may want to use a [free cluster](https://cloud.ibm.com/docs/containers?topic=containers-getting-started#clusters_gs) on IBM Cloud.
21+
22+
Instructions on how to install are available in the main [README.md](https://github.com/IBM/core-dump-handler#installing-the-chart)
23+
24+
## Testing
25+
PR's that modify the codebase will be expected to run against a cluster using the `integration/run.sh` before being accepted.
26+
27+
## Coding style guidelines
28+
Code contributions should be PR'd with `cargo fmt` ran
29+
30+
31+
## Developer Certificate of Origin
32+
33+
This project used the [Developer Certificate of Origin](https://developercertificate.org/). It requires all commit messages to contain the Signed-off-by line with an email address that matches the commit author.
34+
35+
```
36+
Developer Certificate of Origin
37+
Version 1.1
38+
39+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
40+
41+
Everyone is permitted to copy and distribute verbatim copies of this
42+
license document, but changing it is not allowed.
43+
44+
45+
Developer's Certificate of Origin 1.1
46+
47+
By making a contribution to this project, I certify that:
48+
49+
(a) The contribution was created in whole or in part by me and I
50+
have the right to submit it under the open source license
51+
indicated in the file; or
52+
53+
(b) The contribution is based upon previous work that, to the best
54+
of my knowledge, is covered under an appropriate open source
55+
license and I have the right under that license to submit that
56+
work with modifications, whether created in whole or in part
57+
by me, under the same open source license (unless I am
58+
permitted to submit under a different license), as indicated
59+
in the file; or
60+
61+
(c) The contribution was provided directly to me by some other
62+
person who certified (a), (b) or (c) and I have not modified
63+
it.
64+
65+
(d) I understand and agree that this project and the contribution
66+
are public and that a record of the contribution (including all
67+
personal information I submit with it, including my sign-off) is
68+
maintained indefinitely and may be redistributed consistent with
69+
this project or the open source license(s) involved.
70+
```
71+
72+
In order to comply with the DCO please sign every commit as follows:
73+
```
74+
$ git commit -s -m 'This is my commit message'
75+
```
76+
or
77+
78+
```
79+
This is my commit message
80+
81+
Signed-off-by: Random J Developer <[email protected]>
82+
```
2083

2184
## Releases
2285

@@ -41,7 +104,7 @@ are not interested in accepting into the code base.
41104
### Fixing bugs
42105

43106
If you would like to fix a bug, please feel free to open a [PR directly for a small change](https://github.com/ibm/core-dump-handler/pulls).
44-
If you think the fix will be high impact then consider [opening an issue](https://github.com/ibm/repo-template/issues) before sending a
107+
If you think the fix will be high impact then consider [opening an issue](https://github.com/ibm/core-dump-handler/issues) before sending a
45108
pull request so it can be tracked.
46109

47110
### Merge approval
@@ -59,19 +122,4 @@ No new restrictions/conditions are permitted.
59122
- As a contributor, you MUST have the legal right to grant permission for your contribution to be used under these conditions.
60123

61124
## Communication
62-
Please use the [issue list] to keep communication transparent (https://github.com/ibm/repo-template/issues)
63-
64-
## Setup
65-
The quickest way to get setup is to use a [free cluster](https://cloud.ibm.com/docs/containers?topic=containers-getting-started#clusters_gs) on IBM Cloud so you can test your work.
66-
67-
Instructions on how to install are available in the main [README.md](https://github.com/IBM/core-dump-handler#installing-the-chart)
68-
69-
## Testing
70-
PR's that modify the codebase will be expected to run against a cluster using the `integration/run.sh` before being accepted.
71-
72-
## Coding style guidelines
73-
Code contributions should be PR'd with `cargo fmt` ran
74-
75-
**[core-dump-handler](https://github.com/IBM/core-dump-handler/) is an [_OPEN Open Source Projects_](https://openopensource.org/).**
76-
77-
Individuals making significant and valuable contributions are given commit-access to a project to contribute as they see fit. A project is more like an open wiki than a standard guarded open source project.
125+
Please use the [issue list] to keep communication transparent (https://github.com/ibm/core-dump-handler/issues)

0 commit comments

Comments
 (0)