Skip to content

Update links in contribution guide after migrating to the TensorLy organisation #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 31, 2022
Merged

Update links in contribution guide after migrating to the TensorLy organisation #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ How to contribute
-----------------

If you find a bug, or have an idea for a new feature, and you want to know if the contribution is relevant and not
being worked on, you can open a `new issue <https://github.com/MarieRoald/tlviz/issues>`_. For major
being worked on, you can open a `new issue <https://github.com/tensorly/viz/issues>`_. For major
bugs, it can also be useful to include a `minimal, reproducible example <https://stackoverflow.com/help/minimal-reproducible-example>`_,
to make it as easy as possible to fix it.

You can submit implementation of new features or bug/documentation fixes as a `pull-request <https://github.com/MarieRoald/tlviz/pulls>`_.
You can submit implementation of new features or bug/documentation fixes as a `pull-request <https://github.com/tensorly/viz/pulls>`_.

-----------------------
Development environment
Expand All @@ -30,8 +30,8 @@ Then, you can download the TLViz source code and install it together with all th

.. code:: bash

git clone https://github.com/marieroald/tlviz.git
cd tlviz
git clone https://github.com/tensorly/viz.git
cd viz
pip install -e .[devel,test,docs]

This will install TLViz in editable mode, so any change to the source code will be applied to the installed
Expand Down Expand Up @@ -95,4 +95,4 @@ the pattern `plot_*.py` in the `examples`-directory (make sure to follow the `sp
for your scripts).

To ensure that the documentation is up to date, we use `doctest <https://docs.python.org/3/library/doctest.html>`_,
which will evaluate all examples and compare with the expected output. Examples should therefore be seeded.
which will evaluate all examples and compare with the expected output. Examples should therefore be seeded.