Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (36 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

45 lines (36 loc) · 1.51 KB

Goal

This document guides how contributors are joined in the project.

Repository Guide

flowchart TD
  Upstream ~~~ Origin
  Origin ~~~ Branch
  Branch --Resolve an issue--> Origin --Request a merge--> Upstream
Loading

We use Forking Workflow based on Github Flow.
Please follow steps below.

  1. Find proper an issue(only one issue is permitted at same branch)
  2. Select the issue and assign you.
  3. Clone this repository(upstream) to yours(origin).
  4. Make a branch to resolve the issue in origin.
  5. Resolve the issue and marge the branch to origin.
  6. Send a PR to upstream from origin.
  7. Review the PR with other contributors.
  8. After the PR is accepted, sync origin with upstream and continue step 1.

Issue Guide

You should follow the templates.

Pull Request Guide

You should follow the template

Style Guide

We use checkstyle and google guideline.
Before sending PRs, please clean updated codes.

VS Code

  1. Apply Extension Pack for Java plugin.
  2. Apply Checkstyle for Java plugin.