Skip to content
This repository has been archived by the owner on Jun 7, 2024. It is now read-only.

Commit

Permalink
Merge pull request #669 from lmontrieux/housekeeping
Browse files Browse the repository at this point in the history
Update Maintainers list and provide information for contributors
  • Loading branch information
lmontrieux authored Jun 20, 2017
2 parents d821649 + b9cb335 commit ade1d15
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 2 deletions.
43 changes: 43 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Contributing to Nakadi

**Thank you for your interest in Nakadi. Your contributions are highly welcome.**

There are multiple ways of getting involved:

- [Report a bug](#report-a-bug)
- [Suggest a feature](#suggest-a-feature)
- [Contribute code](#contribute-code)

Below are a few guidelines we would like you to follow.
If you need help, please reach out to us by opening an issue.

## Report a bug
Reporting bugs is one of the best ways to contribute. Before creating a bug report, please check that an [issue](https://github.com/zalando/nakadi/issues) reporting the same problem does not already exist. If there is such an issue, you may add your information as a comment.

To report a new bug you should open an issue that summarizes the bug and set the label to "bug".

If you want to provide a fix along with your bug report: That is great! In this case please send us a pull request as described in section [Contribute Code](#contribute-code).

## Suggest a feature
To request a new feature you should open an [issue](https://github.com/zalando/nakadi/issues/new) and summarize the desired functionality and its use case. Set the issue label to "feature".

## Contribute code
This is a rough outline of what the workflow for code contributions looks like:
- Check the list of open [issues](https://github.com/zalando/nakadi/issues). Either assign an existing issue to yourself, or create a new one that you would like work on and discuss your ideas and use cases. It is always best to discuss your plans beforehand, to ensure that your contribution is in line with our goals for Nakadi.
- Fork the repository on GitHub
- Create a topic branch from where you want to base your work. This is usually master.
- Make commits of logical units.
- Write good commit messages (see below).
- Push your changes to a topic branch in your fork of the repository.
- Submit a pull request to [zalando/nakadi](https://github.com/zalando/nakadi)
- Your pull request must receive a :thumbsup: from two [maintainers](https://github.com/zalando/nakadi/blob/master/MAINTAINERS)

Thanks for your contributions!

### Commit messages
Your commit messages ideally can answer two questions: what changed and why. The subject line should feature the “what” and the body of the commit should describe the “why”.

When creating a pull request, its comment should reference the corresponding issue id.

**Have fun, and happy hacking!**

5 changes: 3 additions & 2 deletions MAINTAINERS
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@ Andrey Dyachkov <[email protected]>
Dmitry Sorokin <[email protected]>
Ricardo De Cillo <[email protected]>
Valentine Gogichashvili <[email protected]>
Viktor Buldakov <[email protected]>
Vyacheslav Stepanov <[email protected]>
Vyacheslav Stepanov <[email protected]>
Lionel Montrieux <[email protected]>
Robert Garrett <[email protected]>

0 comments on commit ade1d15

Please sign in to comment.