Skip to content

Latest commit

 

History

History
56 lines (34 loc) · 1.06 KB

CONTRIBUTING.md

File metadata and controls

56 lines (34 loc) · 1.06 KB

Contributing to Come

You're very welcomed to be a contributor to Come! 🎉

This document will show you the best practice of doing some contribution to this repo.

Get the code

  • Fork this repo under your own GitHub account.
  • Clone it to your computer 
    git clone https://github.com/<your GitHub username>/come

Install dependencies

All you need is to install rust.

Create a new branch

You need to new a branch with a meaningful name and checkout it.

Do Some Coding

You can modify whatever you want!

Build

cargo build

Test

cargo test

Commit and push

git add <new file>
git commit -m "<a meaningful message>"
git push

Create a pull request to this repo

Create a pull request on shuosc/come, and check if your code can pass all the tests.

We'll check the pull request now and then, you may also request a review manually if you like.

Need help?

Feel free to open an issue here!