Skip to content

Contributing Guide

Jump to bottom
Donald Dong edited this page Mar 11, 2019 · 3 revisions

Patch

Code Review

Step 1: Make a fork

The fork button is located on the top right of this page. Proposed changes should be pushed on your forked repository.

Step 2: Create a Pull Request

We use GitHub's pull requests to do code review. Make sure your changes are ready for a review before publishing them. Add a meaningful description as the body of the pull request, and request a review from a member in the core development team.

Step 3: Incorporate Feedback

If some changes are necessary, update the branch on your fork, and provide a description for the update. Then push the new changes. If the PR is approved by a reviewer, then it's ready to merge!

Step 4: Merge the pull request

  • We don't use merge commits. Squash your commits and add meaningful descriptions. Read more at Write meaningful commit messages.
  • In your commit messages, reference the pull request and related issues.
PR: #2
Resolve: #3, #4, #5

PR is not a keyword; we use it to reference the discussion thread. Resolve is a keyword. Read more at closing issues using keywords.

Write meaningful commit messages

  • Separate subject from the body with a blank line
  • Limit the subject line to 50 characters
  • Capitalize the subject line
  • Do not end the subject line with a period
  • Use the imperative mood in the subject line
  • Wrap the body at 72 characters
  • Use the body to explain what and why vs. how

Read more about writing commit messages.

Write Docs

For this project to be useful to future students, we need to make produce quality documentation. Here is a fun article to read: Art of Open Source Documentation.

Coding Style

Here are some references:

There should not be any lint errors reported by the CI.

Clone this wiki locally