Skip to content

Latest commit

 

History

History
199 lines (136 loc) · 4.31 KB

b_contributing.md

File metadata and controls

199 lines (136 loc) · 4.31 KB
Raw

Workflow: Contributing

PART A: Select issue

To fetch (someone else's) PR:

git fetch https://github.com/theirusername/reponame.git theirbranch:ourbranch

PART B: Fixing issue

  • Explore and fix issue. This will take the majority of time (!)
  • Make updates to file <file_name>

PART C: Committing change

Create feature branch

git checkout -b <feature_branch>

Commit changes to branch

Please include (#DataUmbrella) in your PR so we can track them.

git add <file_name>
git commit -m 'description for fix'

PART D: Run tests

flake8 formatting test

  • flake8 tests for formatting errors
flake8 <file_name>

pytest sklearn tests

pytest sklearn

This is an example of the output of a successful pytest sklearn: pytest_sklearn_output

Create test file

Run tests on individual test files

  • Create test file under tests directory
  • Run test file
pytest <test_file>

example

pytest /Users/reshamashaikh/scikit-learn/sklearn/metrics/tests/test_classifier.py
pytest /Users/reshamashaikh/scikit-learn/sklearn/metrics/tests/test_mixture.py

This is an example of the output of a successful pytest test_classification.py:

(sklearndev) % pytest sklearn/metrics/tests/test_classification.py
============================================================ test session starts ============================================================
platform darwin -- Python 3.7.1, pytest-4.0.0, py-1.7.0, pluggy-0.8.0
rootdir: /Users/reshamashaikh/scikit-learn, inifile: setup.cfg
collected 75 items                                                                                                                          

sklearn/metrics/tests/test_classification.py ...........................................................................              [100%]

=================================================== 75 passed, 3 warnings in 9.49 seconds ===================================================
(sklearndev) %

PART E: Submit Pull Request

After all tests have passed, push update file(s) to feature branch

  • test_file should be committed to feature branch as well
git add <test_file>
git commit -m 'description for test file'
git push origin <feature_branch>

Submit PR

Do this on GitHub.

REMINDER: Under Conversation [description] include references to which Issues and other PRs that your PR is related to.

Part F: Regression Tests on GitHub

These tests happen automatically after a PR has been submitted:

This is what it looks like when all the checks have passed!

Part G: Next Steps

  • Wait for reviews (be patient)
  • Address review comments in the same branch
  • Pushing to your fork will update the PR
  • Reviewers will "approve" the PR or change title to [MRG + 1]
  • You need 2 approvals for a merge

This is what a merged icon looks like:

Deleting branch after your PR has been merged

git branch -D feature_branch

Returning to work

1. Go into directory where scikit-learn repo has been cloned on your computer

cd scikit-learn

my example: cd /Users/reshamashaikh/software-build/scikit-learn

2. Activate virtual environment

conda activate sklearndev

3. Sync repo before beginning work (master main branch)

git pull upstream main
git push origin main

4. Switch to working branch

git checkout feature_branch

5. Update working branch files

git pull upstream main
git push origin feature_branch