Skip to content

Latest commit

 

History

History
119 lines (83 loc) · 4.27 KB

CONTRIBUTING.md

File metadata and controls

119 lines (83 loc) · 4.27 KB
Raw

How to contribute code

There are 3 ways you can contribute to Tasrif:

  • Fixing bugs/outstanding issues with the existing code;
  • Implementing new operators;
  • Contributing to the examples or to the documentation;

Follow these steps to submit your code contribution.

Step 1. Open an issue

If the changes are minor (simple bug fix or documentation fix), then feel free to open a PR without discussion. Otherwise, we recommend opening an issue (if one doesn't already exist) and discuss your proposed changes. This way, we can give you feedback and validate the proposed changes. Here is a template

Motivation first:

Is it related to a problem/frustration with the library? If so, please explain why. Providing a code snippet that demonstrates the problem is best. Is it related to something you would need for a project? Is it something you worked on and think could benefit the community?

Write a full paragraph describing the feature; Provide a code snippet that demonstrates its future use; In case this is related to a paper, please attach a link; Attach any additional information (drawings, screenshots, etc.) you think may help.

Fork the repository by clicking on the 'Fork' button on the repository's page. This creates a copy of the code under your GitHub user account.

Clone your fork to your local disk, and add the base repository as a remote:

git clone git@github.com:qcri/tasrif.git
cd tasrif
git remote add upstream https://github.com/<your-github-username>/tasrif.git

Create a new branch to hold your development changes:

git checkout -b branch-name

Do not work on the master branch.

Set up a development environment by running the following command in a virtual environment:

python3 -m venv tasrif-env
source tasrif-env/bin/activate
(tasrif-env) pip install --upgrade pip
(tasrif-env) cd tasrif
(tasrif-env) pip install -e .

Make sure you have qa-requirements.txt and requirements.txt installed, so you can set up our pre-commit hooks for code styling.

(tasrif-env) pip install -r requirements.txt
(tasrif-env) pip install -r qa-requirements.txt

At this point, you should set up git pre-commit hooks.

(tasrif-env) pre-commit install

The above will run the following to ensure code consistency every time you commit:

The hooks can also be directly run without making a commit.

# Run all hooks on staged changes
(tasrif-env) pre-commit run

# Run individual hook on staged changed
(tasrif-env) pre-commit run <hook_id>

# Run hooks on specifiv file
(tasrif-env) pre-commit run --files <path_to_file>

# Run hooks on all files
(tasrif-env) pre-commit run --all-files

The pre-commmit hooks are configured in .pre-commit-config.yaml.

If you want to bypass hooks for a commit, this can be done by passing the flag --no-verify with the commit. This however, is not recommended.

Step 2. Make code changes

Make sure that your environment is set from the previous section. You can create your own custom operator by following the Custom Operators section in the tutorial.

After making the changes, check if you have pylint or darglint errors. The CI pipeline checks those errors by default. If you set up the pre-commit hooks correctly, these checks should already be happening. Pylint and Darglint can also be run separately.

(tasrif-env) pre-commit run pylint
(tasrif-env) pre-commit run darglint

Step 3. Create a pull request

Once the change is ready, open a pull request from your branch in your fork to the master branch in Tasrif.

Step 4. Code review

Before waiting for a reviewer to see the pull request, please look into the CI pipeline ran on your branch to see if there are any errors.

Step 5. Merging

Once the pull request is approved, a ready to pull tag will be added to the pull request. A team member will take care of the merging.

Here is an example pull request for your reference.