deepke/.github/CONTRIBUTING.md

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.