From a060b3acbc3d509482f7f3f492e164400980d1f2 Mon Sep 17 00:00:00 2001 From: Khemanorak Khath Date: Tue, 19 Jan 2021 11:44:06 +0700 Subject: [PATCH] Init contributing guide --- CONTRIBUTING.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..40d91ec --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,20 @@ +# Contributing +## Participating in CODIUM Feature Template Process +### Document Format +- Choose the topic that you would like to template to (Django, Angular ...) +- Create a new directory inside that topic and make sure that directory name is kebab-case. +- The template would required a `README.md` file to explain about your feature +- `README.md` format +``` +# Description +- This section is required +- Write the description of what your function does +# Required Packages +- This section is required +- This should be a list of package that required to run your feature + +* If you have more section feel free to add from here +``` + +### Process +- Request a review: Initiate a pull request to the [CODIUM Feature Templates](https://github.com/C0D1UM/feature-templates) when proposed a change or new feature, then assign the review from someone in tech council team. When everything looks good, the pull request will be merged.