Skip to content

Commit

Permalink
Init contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
NorakGithub committed Jan 19, 2021
1 parent 811fd39 commit a060b3a
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit a060b3a

Please sign in to comment.