Switch branches/tags
ARUHA-145-examined-build ARUHA-157-recognise-new-kafka-brokers ARUHA-190-hila-api ARUHA-215-after-merge ARUHA-215-ut ARUHA-304 ARUHA-349-fix ARUHA-349 ARUHA-356 ARUHA-392-fix-codecov ARUHA-402-view-specific-schema-version ARUHA-419 ARUHA-455 ARUHA-456-block-consumers ARUHA-479 ARUHA-519 ARUHA-520-reporting-batch-size ARUHA-522 ARUHA-523 ARUHA-528-timeline-locking-when-publish ARUHA-535-cleanup-timelines ARUHA-554-zappr-fix ARUHA-554 ARUHA-583-fix-endpoint-security-config ARUHA-588 ARUHA-596-commit-performance ARUHA-596-vol3 ARUHA-633 ARUHA-648-improved-logging ARUHA-649-fix-user-journey ARUHA-651 ARUHA-668-investigate-cleanup-policy ARUHA-724 ARUHA-746-update-cleanup-time ARUHA-753 ARUHA-758-forbid-batchlimit-0 ARUHA-765-et-creation-auth ARUHA-769-subscription-stats-performance ARUHA-771-subscription-creation-problem ARUHA-792-log-slos ARUHA-802 ARUHA-806-fix-user-journey ARUHA-817 ARUHA-834 ARUHA-854-hash-partitioning-problem ARUHA-855 ARUHA-869 ARUHA-874-stats-performance-problem-vol2 ARUHA-874 ARUHA-912-release ARUHA-933-authz-documentation ARUHA-953-remove-read-write-scopes ARUHA-954-log-realm ARUHA-960 ARUHA-964-reformat-imports-vol2 ARUHA-979-name-rules-changes ARUHA-983-dont-authorize-sub-create ARUHA-1044-validate ARUHA-1075-db-table-for-admins ARUHA-1079-admin-override-et-permissions ARUHA-1081-fix-debug-log ARUHA-1093 ARUHA-1105 ARUHA-1168 ARUHA-1173-2 ARUHA-1173 ARUHA-1203 ARUHA-1275 ARUHA-1311-collect-ET-metrics ARUHA-1313 ARUHA-1330 ARUHA-1347 ARUHA-1360 ARUHA-1388 ARUHA-1397-release ARUHA-1397 ARUHA-1398 ARUHA-1419-kpi-toggling-fix ARUHA-1428 ARUHA-1442 ARUHA-1457-release ARUHA-1462 ARUHA-1488-1 ARUHA-1488 ARUHA-1500-hila-read-from-partition-api ARUHA-1501-choose-partition-hila ARUHA-1501-print-topology ARUHA-1520-intermediate-version ARUHA-1581 ARUHA-1604-flush-on-stream-timeout ARUHA-1624-out-of-memory ARUHA-1626-commit-sc500 ARUHA-1636 ARUHA-1640 ARUHA-1641-2 ARUHA-1641 ARUHA-1664-time-lag-stats ARUHA-1664-wip ARUHA-1674 ARUHA-1680-final-switch-to-strict ARUHA-1681-fixnpe ARUHA-1693 ARUHA-1757-additional-topic-properties ARUHA-1899 ARUHA-1952 ARUHA-1993-fix-docs-layout ARUHA-1997 ARUHA-2024 LappleApple-patch-1 adyach-patch-1 adyach-patch-2 adyach-patch-3 adyach-patch-4 adyach-patch-deps adyach-patch-now aruha-136-expose-effective-schema aruha-191-getting-started aruha-338-streaming-endpoint aruha-400-major-minor-patch aruha-602 aruha-677-versioning-dummy-changes aruha-681-remove-event-type-with-timelines aruha-713-change-partition-strategy aruha-809-fix-scopes aruha-905 aruha-929-authorization-refactoring aruha-931-cd aruha-931 aruha-961-check-reset-cursors aruha-979-release-version aruha-1015-base-branch aruha-1015-bug-tracking aruha-1015-jetty-500-threads aruha-1015-no-connection-crutch aruha-1033-test2 aruha-1211 aruha-1247-fetchlimit aruha-1247 aruha-1303 aruha-1322-1 aruha-1373-fix-evolution aruha-1391 aruha-1399-nakadi-producer-event aruha-1403-nakadi-consumption-kpi aruha-1681-subscription-authorization-api aruha-1818-ksql-output aruha-profiling automatic-schema-generation change-stack-trace-logging checkstyle-experiment dependencies-upgrade-201807 disable-oauth do-not-override-flow-id enable-forward-slashes-reject eventstore-api-fixed eventstore-latest eventstore-old feature/event-validation feature/topics-controller fix-exposed-stacktrace fix-timelines-admin-rejection gradle-improvements hikari-debug hila-streaming-preparations hp-logs ksql-poc light-subscription-stats logos master-pr-test master nakadi-jvm nakadi-low-level-api-review nakadi-on-play nakadi-stats new-streaming-format nsql optimization-experiment ordering-key-fields profiling-fl1 refactor-exceptions release-candidate release/R2016_04_13_11_02 release/R2016_05_04 release/R2016_07_18 release/R2016_08_02 release/R2016_08_22 release_2.3.3 remove-inmemory-repository-and-use-mockito remove-not-related-code remove-zappr revert-795-aruha-1373-fix-evolution revert-963-ARUHA-1952 satisfy-findbugs short-dns-cache sub-cache test-codecov timeline-producers timeline_crud_storage timeline_crud_timeline timeline_db timeline_locking update-documentation upgrade-libraries upgrade-zalando-problem use-internal-test versioned-topologies
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
44 lines (29 sloc) 2.38 KB

Contributing to Nakadi

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

There are multiple ways of getting involved:

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 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.

Suggest a feature

To request a new feature you should open an issue 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. 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
  • Your pull request must receive a 👍 from two 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!