Skip to content

Commit a18baf4

Browse files
committed
Closes cloudevents#20: contributing guidelines
Signed-off-by: Fabio José <fabiojose@gmail.com>
1 parent 6a1d70c commit a18baf4

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed

CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Contributing to CloudEvents' JavaScript SDK
2+
3+
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
4+
5+
Following you will see some guidelines about how to contribute with
6+
JavaScript SDK.
7+
8+
## Pull Requests
9+
10+
Guidelines about how to perform pull requests.
11+
12+
### PR to `develop`
13+
14+
- fixes in the documentation (readme, contributors)
15+
- propose new files for documentation
16+
- implementation of new features
17+
18+
### PR to `master`
19+
20+
- hot fixes
21+
22+
## Style Guide
23+
24+
_TODO_
25+
26+
### JavaScript Style Guide
27+
28+
_TODO_

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ Official CloudEvents' SDK for JavaScript.
88

99
<img src="https://github.com/cncf/artwork/blob/master/projects/cloudevents/horizontal/color/cloudevents-horizontal-color.png" width="300" height="58" alt="CloudEvents logo">
1010

11+
## Contributing
12+
13+
Before create an awesome PR, please read our [guidelines](./CONTRIBUTING.md).
14+
1115
## Versioning
1216

1317
### Before Spec reaches 1.0

0 commit comments

Comments
 (0)