-
Notifications
You must be signed in to change notification settings - Fork 328
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update CONTRIBUTING.md
- Loading branch information
Yutong Pei
authored
Mar 5, 2019
1 parent
d458de5
commit 6f31a55
Showing
1 changed file
with
2 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,28 +1,11 @@ | ||
Contributing to IoTeX Core | ||
============================ | ||
|
||
The IoTeX Core project operates an open contributor model where anyone is welcome to contribute towards development in the form of peer review, testing and patches. This document explains the practical process and guidelines for contributing. | ||
|
||
Contributor Workflow | ||
-------------------- | ||
|
||
The codebase is maintained using the "contributor workflow" where everyone | ||
without exception contributes patch proposals using "pull requests". This | ||
facilitates social contribution, easy testing and peer review. | ||
|
||
To contribute a patch, the workflow is as follows: | ||
|
||
1. Fork repository | ||
1. Create topic branch | ||
1. Commit patches | ||
|
||
In general commits should be atomic and diffs should be easy to read, and the [coding conventions](https://github.com/golang/go/wiki/CodeReviewComments) | ||
must be adhered to. | ||
|
||
The IoTeX Core project operates an open contributor model where anyone is welcome to contribute towards development in the form of peer review, testing and patches. If you are interested in contributing to the project then checkout the [Contributor's Guide](https://github.com/iotexproject/iotex-core/wiki/IoTex-Contributor-Guide) | ||
|
||
Copyright | ||
--------- | ||
|
||
By contributing to this repository, you agree to license your work under the | ||
Apache 2.0 license. Any work contributed where you are not the original | ||
author must contain its license header with the original author(s) and source. | ||
author must contain its license header with the original author(s) and source. |