43 lines
898 B
Markdown
43 lines
898 B
Markdown
# Contributing to CloudEvents' JavaScript SDK
|
|
|
|
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
|
|
|
|
Following you will see some guidelines about how to contribute with
|
|
JavaScript SDK.
|
|
|
|
## Branch Management
|
|
|
|
We use Gitflow to manage our branches and that's ok when `develop` branch is
|
|
ahead of `master`.
|
|
|
|
- [Gitflow](https://nvie.com/posts/a-successful-git-branching-model/) by @nvie
|
|
|
|
## Changelog
|
|
|
|
Always update the [CHANGELOG.md](./CHANGELOG.md), following
|
|
[this semantics](https://keepachangelog.com/en/1.0.0/).
|
|
|
|
## Pull Requests
|
|
|
|
Guidelines about how to perform pull requests.
|
|
|
|
- before submit the PR, open an issue and link them
|
|
|
|
### PR to `develop`
|
|
|
|
- fixes in the documentation (readme, contributors)
|
|
- propose new files for the documentation
|
|
- implementation of new features
|
|
|
|
### PR to `master`
|
|
|
|
- hot fixes
|
|
|
|
## Style Guide
|
|
|
|
_TODO_
|
|
|
|
### JavaScript Style Guide
|
|
|
|
_TODO_
|