Replace how-to-contribute documentation (#6802)
author오형석/On-Device Lab(SR)/Staff Engineer/삼성전자 <hseok82.oh@samsung.com>
Thu, 22 Aug 2019 01:39:41 +0000 (10:39 +0900)
committer이춘석/On-Device Lab(SR)/Staff Engineer/삼성전자 <chunseok.lee@samsung.com>
Thu, 22 Aug 2019 01:39:41 +0000 (10:39 +0900)
Replace two how-to-contribute documentation and remove duplication

Signed-off-by: Hyeongseok Oh <hseok82.oh@samsung.com>
docs/HowToContribute.md [moved from docs/nnfw/HowToContribute.md with 91% similarity]
docs/nncc/contribution_guide.md [deleted file]

similarity index 91%
rename from docs/nnfw/HowToContribute.md
rename to docs/HowToContribute.md
index a685c8e..c6f89c3 100644 (file)
@@ -19,8 +19,8 @@ This section explains the steps to create a pull request (PR).
 
 1. Create an issue
 
-   Maintainers will accept your contribution only when it is well aligned with the [roadmap and
-   design principles](./roadmap.md) of _nnfw_. So, it is optional, but recommended for contributors
+   Maintainers will accept your contribution only when it is well aligned with the roadmap and
+   design principles of [_nnfw_](./nnfw/roadmap.md) and [_nncc_](./nncc/roadmap.md). So, it is optional, but recommended for contributors
    to create an issue and have a discussion with maintainers before writing code.
 
 1. Create a draft PR
@@ -70,9 +70,3 @@ This section explains the steps to create a pull request (PR).
    your pull request upon such feedbacks. These update commits will be squashed into the first
    commit of your pull request later. Please do **NOT** include a sign-off message or write a full
    description for update commits.
-
-
-# Note
-
-This document is originated from the [contribution guide in
-nncc](https://github.sec.samsung.net/STAR/nncc/blob/master/doc/contribution_guide.md).
diff --git a/docs/nncc/contribution_guide.md b/docs/nncc/contribution_guide.md
deleted file mode 100644 (file)
index 44806a0..0000000
+++ /dev/null
@@ -1,57 +0,0 @@
-_nncc_ always welcomes your contribution, but there are basic guidelines that you should follow
-in order to make your contribution be accepted.
-
-This document explains such guidelines for beginners.
-
-### HOWTO
-#### How to create a Pull Request
-
-This section explains the steps to create a pull request (PR).
-
-1. Create an issue
-
-   Maintainers will accept your contribution only when it is well aligned with the roadmap and design
-principles of _nncc_. So, it is optional, but recommended for contributors to create an issue and have
-a discussion with maintainers before writing code.
-
-1. Create a draft PR
-
-   Maintainers will accept your pull request only when it is **reasonably small** and **focused**.
-Sometimes, your contribution may require huge and loosely-coupled changes. You **should** split your
-contribution into multiple small, but focused pull requests in this case. Unfortunately, it is possible
-that maintainers reject your pull request as it is hard for them to understand the intuition behind
-these changes. So, it is optional, but recommended for contributors to present the full draft of your
-contribution and have a discussion with maintainers before creating PR(s).
-
-1. Create a commit
-
-   It is time to create a commit for submission once you are convinced that your contribution is ready
-to go. Please include signed-off message at the end of commit message. If not, your pull request will
-be **rejected** by CI.
-
-1. Check code format locally
-
-   _nncc_ has its code formatting rules, and any pull request that violates these rules will be
-**rejected** by CI. So, it is optional, but recommended for contributor to check code format locally
-before submission.
-
-1. Create a PR
-
-   It is time to send a pull request. Please explain your intention via descrpition. Maintainers will
-review your pull request based on that description. Each pull request needs approval from at least two
-reviewers to be accepted. Note that **description should include at least four words**. If not, your
-pull request will be **rejected** by CI.
-
-1. Request review
-
-   Please assign reviewers if you need review from them. Maintainers will honor your review request,
-and accept your pull request only when all the reviewer approve your pull request. Note that this does
-**NOT** mean that you should assign reviewers. Maintainers (or reviewers) will review your pull request
-even without explicit review request.
-
-1. Update per feedback
-
-   Sometimes, maintainers (or reviewers) will request changes on your pull request. Please update your
-pull request upon such feedbacks. These update commits will be squashed into the first commit of your
-pull request later. Please do **NOT** include a sign-off message or write a full description for
-update commits.