Document for an incubating project (#666)
author최성진/동작제어Lab(SR)/Principal Engineer/삼성전자 <lotieye.choi@samsung.com>
Wed, 18 Jul 2018 09:02:13 +0000 (18:02 +0900)
committer박종현/동작제어Lab(SR)/Staff Engineer/삼성전자 <jh1302.park@samsung.com>
Wed, 18 Jul 2018 09:02:13 +0000 (18:02 +0900)
This commit introduces a document for how to start an incubating project.

Signed-off-by: lotieye.choi <lotieye.choi@samsung.com>
doc/project_guide.md [new file with mode: 0644]

diff --git a/doc/project_guide.md b/doc/project_guide.md
new file mode 100644 (file)
index 0000000..069f3b7
--- /dev/null
@@ -0,0 +1,24 @@
+### How to create your own project
+_nncc_ aims to make it easy to develop optimized, retargetable NN compilers. Anyone or team interested in _nncc_ can create a new incubating project.
+
+#### Subject
+Subject is related to NN(Neural Network) complier. Some examples are below, but not limited:
+- NN IR(Intermediate Representation)
+- Extended frontend and backend
+- High-performance (model optimization, memory optimization, scheduling, etc.)
+- Tools (verification, benchmark, visualization, etc.)
+- Tutorial, testbed
+
+#### How to propose
+There is no formal proposal process. Anyone can submit an issue or a PR as a starting point of a proposal. It would be helpful that the submissions have documents or descriptions containing the followings to share your idea and concept and attract new contibutors to your project (not mandatory):
+- Overview, goal or architecture description to explain your project
+- How-to guide including building and running your programs
+
+#### Directory to use
+- A directory under `contrib/`, which starts with your project name.
+
+#### Requirement
+- A project should follow the formal review process that _nncc_ is currently using [[(How to create a Pull Request (in contribution guide)](https://github.sec.samsung.net/STAR/nncc/blob/master/doc/contribution_guide.md#how-to-create-a-pull-request)].
+
+#### How to contribute
+Anyone who wants to contribute can create and submit PRs and issues following [nncc contribution_guide](https://github.sec.samsung.net/STAR/nncc/blob/master/doc/contribution_guide.md). _nncc_ always welcomes your contribution.