SkyID
/
deepke
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Create CONTRIBUTING.md

This commit is contained in:
yuwl798180 2019-12-04 10:41:53 +08:00 committed by GitHub
parent 8dd7a82960
commit 4dbb74f7b6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
CONTRIBUTING.md Normal file
View File

@ -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.