From 4dbb74f7b69ce24e072d6d92aa936702003e50e9 Mon Sep 17 00:00:00 2001 From: yuwl798180 Date: Wed, 4 Dec 2019 10:41:53 +0800 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a31797d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,22 @@ +# Contributing +Welcome to the Deepke community! We're building relation extraction toolkits for research. + +## Simple Internal Code +It's useful for users to look at the code and understand very quickly what's happening. Many users won't be engineers. Thus we need to value clear, simple code over condensed ninja moves. While that's super cool, this isn't the project for that :) + +## Contribution Types +Currently looking for help implementing new features or adding bug fixes. + +## Bug Fixes: +1. Submit a github issue. +2. Fix it. +3. Submit a PR! + +## New Features: +1. Submit a github issue. +2. We'll agree on the feature scope. +3. Submit a PR! + +## Coding Styleguide +1. Test the code with flake8. +2. Use f-strings.