"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "CONTRIBUTING.txt" between
scikit-image-0.18.1.tar.gz and scikit-image-0.18.3.tar.gz

About: scikit-image is a collection of algorithms for image processing in Python.

CONTRIBUTING.txt  (scikit-image-0.18.1):CONTRIBUTING.txt  (scikit-image-0.18.3)
skipping to change at line 60 skipping to change at line 60
<https://github.com/scikit-image/>`_, our dataset is stored on `gitlab <https://github.com/scikit-image/>`_, our dataset is stored on `gitlab
<https://gitlab.com/scikit-image/data>`_ and fetched with `pooch <https://gitlab.com/scikit-image/data>`_ and fetched with `pooch
<https://github.com/fatiando/pooch>`_. New data must be submitted on <https://github.com/fatiando/pooch>`_. New data must be submitted on
gitlab. Once merged, the data registry ``skimage/data/_registry.py`` gitlab. Once merged, the data registry ``skimage/data/_registry.py``
in the main codebase on github must be updated. in the main codebase on github must be updated.
2. Develop your contribution: 2. Develop your contribution:
* Pull the latest changes from upstream:: * Pull the latest changes from upstream::
git checkout master git checkout main
git pull upstream master git pull upstream main
* Create a branch for the feature you want to work on. Since the * Create a branch for the feature you want to work on. Since the
branch name will appear in the merge message, use a sensible name branch name will appear in the merge message, use a sensible name
such as 'transform-speedups':: such as 'transform-speedups'::
git checkout -b transform-speedups git checkout -b transform-speedups
* Commit locally as you progress (``git add`` and ``git commit``) * Commit locally as you progress (``git add`` and ``git commit``)
3. To submit your contribution: 3. To submit your contribution:
skipping to change at line 130 skipping to change at line 130
If your change introduces a deprecation, add a reminder to ``TODO.txt`` If your change introduces a deprecation, add a reminder to ``TODO.txt``
for the team to remove the deprecated functionality in the future. for the team to remove the deprecated functionality in the future.
.. note:: .. note::
To reviewers: if it is not obvious from the PR description, add a short To reviewers: if it is not obvious from the PR description, add a short
explanation of what a branch did to the merge message and, if closing a explanation of what a branch did to the merge message and, if closing a
bug, also add "Closes #123" where 123 is the issue number. bug, also add "Closes #123" where 123 is the issue number.
Divergence between ``upstream master`` and your feature branch Divergence between ``upstream main`` and your feature branch
------------------------------------------------------------
If GitHub indicates that the branch of your Pull Request can no longer If GitHub indicates that the branch of your Pull Request can no longer
be merged automatically, merge the master branch into yours:: be merged automatically, merge the main branch into yours::
git fetch upstream master git fetch upstream main
git merge upstream/master git merge upstream/main
If any conflicts occur, they need to be fixed before continuing. See If any conflicts occur, they need to be fixed before continuing. See
which files are in conflict using:: which files are in conflict using::
git status git status
Which displays a message like:: Which displays a message like::
Unmerged paths: Unmerged paths:
(use "git add <file>..." to mark resolution) (use "git add <file>..." to mark resolution)
both modified: file_with_conflict.txt both modified: file_with_conflict.txt
Inside the conflicted file, you'll find sections like these:: Inside the conflicted file, you'll find sections like these::
<<<<<<< HEAD <<<<<<< HEAD
The way the text looks in your branch The way the text looks in your branch
======= =======
The way the text looks in the master branch The way the text looks in the main branch
>>>>>>> master >>>>>>> main
Choose one version of the text that should be kept, and delete the Choose one version of the text that should be kept, and delete the
rest:: rest::
The way the text looks in your branch The way the text looks in your branch
Now, add the fixed file:: Now, add the fixed file::
git add file_with_conflict.txt git add file_with_conflict.txt
skipping to change at line 605 skipping to change at line 605
The command above is fast, but doesn't test the performance of the code The command above is fast, but doesn't test the performance of the code
adequately. To do that you may want to run the benchmark in your current adequately. To do that you may want to run the benchmark in your current
environment to see the performance of your change as you are developing new environment to see the performance of your change as you are developing new
features. The command ``asv run -E existing`` will specify that you wish to run features. The command ``asv run -E existing`` will specify that you wish to run
the benchmark in your existing environment. This will save a significant amount the benchmark in your existing environment. This will save a significant amount
of time since building scikit-image can be a time consuming task:: of time since building scikit-image can be a time consuming task::
asv run -E existing -b TransformSuite asv run -E existing -b TransformSuite
Comparing results to master Comparing results to main
~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~
Often, the goal of a PR is to compare the results of the modifications in terms Often, the goal of a PR is to compare the results of the modifications in terms
speed to a snapshot of the code that is in the master branch of the speed to a snapshot of the code that is in the main branch of the
``scikit-image`` repository. The command ``asv continuous`` is of help here:: ``scikit-image`` repository. The command ``asv continuous`` is of help here::
asv continuous master -b TransformSuite asv continuous main -b TransformSuite
This call will build out the environments specified in the ``asv.conf.json`` This call will build out the environments specified in the ``asv.conf.json``
file and compare the performance of the benchmark between your current commit file and compare the performance of the benchmark between your current commit
and the code in the master branch. and the code in the main branch.
The output may look something like:: The output may look something like::
$ asv continuous master -b TransformSuite $ asv continuous main -b TransformSuite
· Creating environments · Creating environments
· Discovering benchmarks · Discovering benchmarks
·· Uninstalling from conda-py3.7-cython-numpy1.15-scipy ·· Uninstalling from conda-py3.7-cython-numpy1.15-scipy
·· Installing 544c0fe3 <benchmark_docs> into conda-py3.7-cython-numpy1.15-scip y. ·· Installing 544c0fe3 <benchmark_docs> into conda-py3.7-cython-numpy1.15-scip y.
· Running 4 total benchmarks (2 commits * 2 environments * 1 benchmarks) · Running 4 total benchmarks (2 commits * 2 environments * 1 benchmarks)
[ 0.00%] · For scikit-image commit 37c764cb <benchmark_docs~1> (round 1/2): [ 0.00%] · For scikit-image commit 37c764cb <benchmark_docs~1> (round 1/2):
[...] [...]
[100.00%] ··· ...ansform.TransformSuite.time_hough_line 33.2±2ms [100.00%] ··· ...ansform.TransformSuite.time_hough_line 33.2±2ms
BENCHMARKS NOT SIGNIFICANTLY CHANGED. BENCHMARKS NOT SIGNIFICANTLY CHANGED.
In this case, the differences between HEAD and master are not significant In this case, the differences between HEAD and main are not significant
enough for airspeed velocity to report. enough for airspeed velocity to report.
It is also possible to get a comparison of results for two specific revisions It is also possible to get a comparison of results for two specific revisions
for which benchmark results have previously been run via the `asv compare` for which benchmark results have previously been run via the `asv compare`
command:: command::
asv compare v0.14.5 v0.17.2 asv compare v0.14.5 v0.17.2
Finally, one can also run ASV benchmarks only for a specific commit hash or Finally, one can also run ASV benchmarks only for a specific commit hash or
release tag by appending ``^!`` to the commit or tag name. For example to run release tag by appending ``^!`` to the commit or tag name. For example to run
 End of changes. 11 change blocks. 
15 lines changed or deleted 16 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)