Skip to content

Commit 788d5c3

Browse files
Added CONTRIBUTING.md
1 parent 9e91223 commit 788d5c3

File tree

2 files changed

+134
-1
lines changed

2 files changed

+134
-1
lines changed

CONTRIBUTING.md

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
# Contributing to CloudEvents SDK Rust
2+
3+
This page contains information about reporting issues, how to suggest changes as
4+
well as the guidelines we follow for how our documents are formatted.
5+
6+
## Table of Contents
7+
8+
- [Reporting an Issue](#reporting-an-issue)
9+
- [Preparing the environment](#preparing-the-environment)
10+
- [Suggesting a Change](#suggesting-a-change)
11+
12+
## Reporting an Issue
13+
14+
To report an issue, or to suggest an idea for a change that you haven't had time
15+
to write-up yet, open an [issue](https://github.com/cloudevents/sdk-rust/issues). It
16+
is best to check our existing
17+
[issues](https://github.com/cloudevents/sdk-rust/issues) first to see if a similar
18+
one has already been opened and discussed.
19+
20+
## Preparing the environment
21+
22+
In order to start developing this project,
23+
you need to install the Rust tooling using [rustup](https://rustup.rs/).
24+
25+
### Development commands
26+
27+
To build the project:
28+
29+
```sh
30+
cargo build --all-features
31+
```
32+
33+
To run all tests:
34+
35+
```sh
36+
cargo test --all-features
37+
```
38+
39+
To build and open the documentation:
40+
41+
```sh
42+
cargo doc --lib --open
43+
```
44+
45+
To run the code formatter:
46+
47+
```sh
48+
cargo fmt
49+
```
50+
51+
## Suggesting a change
52+
53+
To suggest a change to this repository, submit a
54+
[pull request](https://github.com/cloudevents/spec/pulls)(PR) with the complete
55+
set of changes you'd like to see. See the
56+
[Spec Formatting Conventions](#spec-formatting-conventions) section for the
57+
guidelines we follow for how documents are formatted.
58+
59+
Each PR must be signed per the following section.
60+
61+
### Sign your work
62+
63+
The sign-off is a simple line at the end of the explanation for the patch. Your
64+
signature certifies that you wrote the patch or otherwise have the right to pass
65+
it on as an open-source patch. The rules are pretty simple: if you can certify
66+
the below (from [developercertificate.org](http://developercertificate.org/)):
67+
68+
```
69+
Developer Certificate of Origin
70+
Version 1.1
71+
72+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
73+
1 Letterman Drive
74+
Suite D4700
75+
San Francisco, CA, 94129
76+
77+
Everyone is permitted to copy and distribute verbatim copies of this
78+
license document, but changing it is not allowed.
79+
80+
Developer's Certificate of Origin 1.1
81+
82+
By making a contribution to this project, I certify that:
83+
84+
(a) The contribution was created in whole or in part by me and I
85+
have the right to submit it under the open source license
86+
indicated in the file; or
87+
88+
(b) The contribution is based upon previous work that, to the best
89+
of my knowledge, is covered under an appropriate open source
90+
license and I have the right under that license to submit that
91+
work with modifications, whether created in whole or in part
92+
by me, under the same open source license (unless I am
93+
permitted to submit under a different license), as indicated
94+
in the file; or
95+
96+
(c) The contribution was provided directly to me by some other
97+
person who certified (a), (b) or (c) and I have not modified
98+
it.
99+
100+
(d) I understand and agree that this project and the contribution
101+
are public and that a record of the contribution (including all
102+
personal information I submit with it, including my sign-off) is
103+
maintained indefinitely and may be redistributed consistent with
104+
this project or the open source license(s) involved.
105+
```
106+
107+
Then you just add a line to every git commit message:
108+
109+
Signed-off-by: Joe Smith <joe.smith@email.com>
110+
111+
Use your real name (sorry, no pseudonyms or anonymous contributions.)
112+
113+
If you set your `user.name` and `user.email` git configs, you can sign your
114+
commit automatically with `git commit -s`.
115+
116+
Note: If your git config information is set properly then viewing the `git log`
117+
information for your commit will look something like this:
118+
119+
```
120+
Author: Joe Smith <joe.smith@email.com>
121+
Date: Thu Feb 2 11:41:15 2018 -0800
122+
123+
Update README
124+
125+
Signed-off-by: Joe Smith <joe.smith@email.com>
126+
```
127+
128+
Notice the `Author` and `Signed-off-by` lines match. If they don't your PR will
129+
be rejected by the automated DCO check.

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1-
# CloudEvents Rust SDK
1+
# CloudEvents SDK Rust
22

33
Work in progress SDK for [CloudEvents](https://github.com/cloudevents/spec)
4+
5+
## Development & Contributing
6+
7+
If you're interested in contributing to sdk-rust, look at [Contributing documentation](CONTRIBUTING.md)

0 commit comments

Comments
 (0)