Skip to content

Home

Jump to bottom
Raigor edited this page Sep 16, 2022 · 33 revisions

Welcome!

First off, thank you for your contribution! 🎉🚀💯

Please check out the Apache Code of Conduct to find out more about the Apache Way and our Get Involved resource for a quick start guide.

How can you support the ShardingSphere community?

Contributions can be made in many ways:

  1. Help others in the issues

  • Help solve problems with the issues

  • Remind the authors to provide a demo if they are reporting for a bug

  • Try to reproduce the problem as described in the issues

  1. Make pull requests to fix bugs or implement new features

  2. Help with editing or translating the documents

  3. Discuss in the mailing list

  4. Join the ShardingSphere Slack community

  5. Spread the word! Tweet or engage with @ShardingSphere on Twitter

  6. Bit of a writer? Consider submitting a piece for publication on the ShardingSphere Medium page and official blog and we will feature you on all our media channels as well

How to Setup Your Dev Environment?

The following guide helps you to set up the developing environment for ShardingSphere.

Inside you’ll find everything you need for your software environment setup with examples, including:

  1. JDK Installation
  2. Environment Variable Set Up
  3. IDEA Download and Install
  4. IDEA Clone Code
  5. How to Compile Project and Environment

Once done, your ShardingSphere environment will be set, and you’ll be able to participate in the project’s community building.

Guide

  • New Contributor Guide: Feel free to check the Contributor’s Guide too for more info on Developer Flow and quickly learn how to contribute.

  • Committer Guide: We follow the Apache Community’s process on accepting a new committer. Active contributors will be invited by ShardingSphere PMCs and Committers to join them in becoming a Committer or PMC.

How to Build

Build Apache ShardingSphere

./mvnw clean install -Prelease

Or a faster way:

./mvnw clean install -Prelease -T1C -DskipTests -Djacoco.skip=true -Dcheckstyle.skip=true -Drat.skip=true -Dmaven.javadoc.skip=true -B

Or if you need a docker image of ShardingSphere-Proxy:

./mvnw clean install -Prelease,docker -T1C -DskipTests -Djacoco.skip=true -Dcheckstyle.skip=true -Drat.skip=true -Dmaven.javadoc.skip=true -B

Artifact:

shardingsphere-distribution/shardingsphere-src-distribution/target/apache-shardingsphere-${latest.release.version}-src.zip  # Source code package of Apache ShardingSphere
shardingsphere-distribution/shardingsphere-jdbc-distribution/target/apache-shardingsphere-${latest.release.version}-shardingsphere-jdbc-bin.tar.gz  # Binary package of ShardingSphere-JDBC
shardingsphere-distribution/shardingsphere-proxy-distribution/target/apache-shardingsphere-${latest.release.version}-shardingsphere-proxy-bin.tar.gz  # Binary package of ShardingSphere-Proxy
Clone this wiki locally