From 300b98a171b3638669c4e0e33127934a81f6ac6b Mon Sep 17 00:00:00 2001 From: Renato Mefi Date: Fri, 16 Nov 2018 14:05:40 +0100 Subject: [PATCH] Add table of contents --- CONTRIBUTE.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md index c9897b389..33f1bd659 100644 --- a/CONTRIBUTE.md +++ b/CONTRIBUTE.md @@ -1,7 +1,29 @@ -## Contributing to Debezium +# Contributing to Debezium The Debezium community welcomes anyone that wants to help out in any way, whether that includes reporting problems, helping with documentation, or contributing code changes to fix bugs, add tests, or implement new features. This document outlines the basic steps required to work with and contribute to the Debezium codebase. +## Table of contents + +- [Talk to us](#talk-to-us) + - [User chat](https://gitter.im/debezium/user) + - [Developers chat](https://gitter.im/debezium/user) - Only for internal development subjects + - [Google Group](https://groups.google.com/forum/#!forum/debezium) + - [JIRA](https://issues.jboss.org/projects/DBZ/issues/) - You can [create an account for free](https://developer.jboss.org/register.jspa) +- [Install the tools](#install-the-tools) +- Repository + - [GitHub account](#github-account) + - [Fork the Debezium repository](#fork-the-debezium-repository) + - [Clone your fork](#clone-your-fork) + - [Get the latest upstream code](#get-the-latest-upstream-code) +- Local development + - [Building locally](#building-locally) + - [Running and debugging tests](#running-and-debugging-tests) + - [Making changes](#making-changes) + - [Rebasing](#rebasing) +- Proposing the changes + - [Creating a pull request](#creating-a-pull-request) + - [Summary](#summary) + ### Talk to us You can talk to us in our [chat room for users](https://gitter.im/debezium/user) or on our [Google Group](https://groups.google.com/forum/#!forum/debezium). If you want to contribute, consider joining the [chat room for developers](https://gitter.im/debezium/dev). We also [track our issues using JIRA](https://issues.jboss.org/projects/DBZ/issues/) and you can [create an account for free](https://developer.jboss.org/register.jspa); please don't create GitHub issues.