Skip to content

Latest commit

 

History

History
96 lines (73 loc) · 4.29 KB

CONTRIBUTING.md

File metadata and controls

96 lines (73 loc) · 4.29 KB
Raw

Contributing to icd-coding-benchmark

This project is a community effort, and everyone is welcome to contribute!

If you are interested in contributing to icd-coding-benchmark, there are many ways to help out. Your contributions may fall into the following categories:

  1. It helps us very much if you could

    • Report issues you’re facing
    • Give a 👍 on issues that others reported and that are relevant to you
    • Spread a word about the project or simply ⭐ to say "I use it"

  2. Answering queries on the issue tracker, investigating bugs and reviewing other developers’ pull requests are very valuable contributions that decrease the burden on the project maintainers.

  3. You would like to improve the documentation. This is no less important than improving the library itself! If you find a typo in the documentation, do not hesitate to submit a GitHub pull request.

  4. You would like to propose a new feature and implement it

    • Post about your intended feature, and we shall discuss the design and implementation. Once we agree that the plan looks good, go ahead and implement it.

  5. You would like to implement a feature or bug-fix for an outstanding issue

    • Look at the issues labelled as "good first issue".
    • Pick an issue and comment on the task that you want to work on this feature.
    • If you need more context on a particular issue, please ask and we shall provide.

Environment

To make sure all dependencies are accounted for we recommend to use a different environment, If you have not worked on an environment before you can check it out here https://realpython.com/python-virtual-environments-a-primer/, you can use the environment.yml file or install the dependencies using

pip install -r requirements.txt

In case you have installed a new dependency which is necessary for the issue you are working on (keep in mind we want to keep minimal dependencies) update that in the requirements.txt file.

Formatting Code

To ensure the codebase complies with a style guide, we use flake8, black and isort tools to format and check codebase for compliance with PEP8. To install those tools with pip, please run

pip install flake8 black isort
Formatting without pre-commit

If you choose not to use pre-commit, you can take advantage of IDE extensions configured to black format or invoke black manually to format files and commit them.

# This should autoformat the files
isort -rc .
black .
# Run lint checking
flake8 src/
# If everything is OK, then commit
git add .
git commit -m "Added awesome feature"
Formatting with pre-commit

To automate the process, we have configured the repo with pre-commit hooks to use black to autoformat the staged files to ensure every commit complies with a style guide. This requires some setup, which is described below:

  1. Install pre-commit in your python environment.
  2. Run pre-commit install that configures a virtual environment to invoke black, isort and flake8 on commits.
pip install pre-commit
pre-commit install
  1. When files are committed:
    • If the stages files are not compliant with black, black will autoformat the staged files. If this were to happen, files should be staged and committed again. See example code below.
    • If the staged files are not compliant with flake8, errors will be raised. These errors should be fixed and the files should be committed again. See example code below.
git add .
git commit -m "Added awesome feature"
# DONT'T WORRY IF ERRORS ARE RAISED.
# YOUR CODE IS NOT COMPLIANT WITH flake8, isort or black
# Fix any flake8 errors by following their suggestions
# isort and black will automatically format the files so they might look different, but you'll need to stage the files
# again for committing
# After fixing any flake8 errors
git add .
git commit -m "Added feature"

Send a PR

If everything is OK, please send a Pull Request to https://github.com/dalgu90/icd-coding-benchmark

If you are not familiar with creating a Pull Request, here are some guides: