Welcome to the StarRocks community! We're glad to have you here. This is the starting point for joining and contributing to the StarRocks community- improving docs, contributing code, giving talks, etc. For open-source first-timers, this repo also provides resources and guidance for you to complete your first pull request (PR).

Code is power. Community is strength. Together we create magic!

The fastest way to learn is by participating! Join the conversations to get support and support others!

💬Slack (EN) | 📝 Forum (CN) | ❓Issues |🐦 Twitter | 📆Blogs & Events

Whether you are an experienced developer or a code newbie, stepping into the world of open source and creating your first PR can be quite daunting. The guide here intends to help new contributors get familiar with GitHub workflow and learn how to contribute by simply adding your name to the contributor.md. Follow the steps below to learn how it works:

✨ Acknowledgment: This project is inspired by firstcontributions.

Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the copy to clipboard icon.

Open a terminal and run the following git command:

git clone "url you just copied"

where "url you just copied" (without the quotation marks) is the url to this repository (your fork of this project). See the previous steps to obtain the url.

For example:

git clone https://github.com/this-is-you/first-contributions.git

where this-is-you is your GitHub username. Here you're copying the contents of the first-contributions repository on GitHub to your computer.

Change to the repository directory on your computer (if you are not already there):

cd first-contributions

Now create a branch using the git checkout command:

git checkout -b your-new-branch-name

For example:

git checkout -b add-alonzo-church

(The name of the branch does not need to have the word add in it, but it's a reasonable thing to include because the purpose of this branch is to add your name to a list.)

Now open Contributors.md file in a text editor, add your name to it. Don't add it at the beginning or end of the file. Put it anywhere in between. Now, save the file.

If you go to the project directory and execute the command git status, you'll see there are changes.

Add those changes to the branch you just created using the git add command:

git add Contributors.md

Now commit those changes using the git commit command:

git commit -m "Add <your-name> to Contributors list"

replacing <your-name> with your name.

Push your changes using the command git push:

git push origin <add-your-branch-name>

replacing <add-your-branch-name> with the name of the branch you created earlier.

We require contributors to sign Contributor License Agreement (CLA) when contributing to StarRocks. The checks will fail if you don't have it completed when submitting PR.

For more information, see what is CLA.

If you go to your repository on GitHub, you'll see a Compare & pull request button. Click on that button.

Now submit the pull request.

Soon your changes will be merging into the master branch. You will get a notification email once the changes have been merged.

Now you have successfully submitted your first PR, you can now head over to other repositories to continue contributing. However, the workflow and requirements may be a little different from our early practice. Read Contributing to StarRocks Contributing to StarRocks to learn more.

Now you can:

1. Pick a good first issue and start contributing
2. File an issue, when problems and requirements are found
3. Improve docs
4. Share your experience with our community members by participating in talks, events, writing blogs, answering questions, etc.