Skip to content

Commit f4a30aa

Browse files
Fix broken links in CONTRIBUTING.md (openvinotoolkit#919)
* Fix broken links in CONTRIBUTING.md * Update CONTRIBUTING.md --------- Co-authored-by: Adrian Boguszewski <adekboguszewski@gmail.com>
1 parent a64182b commit f4a30aa

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

CONTRIBUTING.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ To do this, there are a few requirements that all notebooks need to pass.
110110
`function(a=1, b=2)` instead of `function(1, 2)`
111111
5. Use `from pathlib import Path` for path manipulation instead of `os.path`
112112
6. Add type hints to functions: https://www.python.org/dev/peps/pep-0484/
113-
7. Add ReST style docstrings (see[110](https://docs.openvino.ai/latest/notebooks/210-ct-scan-live-inference-with-output.html)
113+
7. Add ReST style docstrings (see [403](https://github.com/openvinotoolkit/openvino_notebooks/blob/main/notebooks/403-action-recognition-webcam/403-action-recognition-webcam.ipynb)
114114
for an example). It is not necessary to specify the parameter type in the docstring, since
115115
type hints are already added to the function definition.
116116
8. Do not use global variables in functions: a function should not depend on values that are
@@ -275,7 +275,7 @@ standard `diff` tool for `git`, with much more useful output than the regular `g
275275

276276
#### JupyterLab Code Formatter
277277

278-
[JupyterLab Code Formatter](https://jupyterlab-code-formatter.readthedocs.io/en/latest/) adds a
278+
[JupyterLab Code Formatter](https://ryantam626.github.io/jupyterlab_code_formatter/index.html) adds a
279279
button to Jupyter Lab to automatically format the code in notebooks with black and isort. Please
280280
use either this extension or a different way to automatically format your notebook.
281281

@@ -288,12 +288,12 @@ use either this extension or a different way to automatically format your notebo
288288
mentioned in the [Validation](#Validation) section.
289289
3. Create a branch in this fork, from the *main* branch. Name the
290290
branch however you like.
291-
4. Doublecheck the points in the [Design](#Design) and [Validation](#Validation) sections.
291+
4. Doublecheck the points in the [Design Decisions](#design-decisions) and [Validation](#Validation) sections.
292292
5. Check that your notebook works in the CI
293293
- Go to the GitHub page of your fork, click on _Actions_, select _nbval_ on the left. There will
294294
be a message _This workflow has a workflow_dispatch event trigger._ and a _Run workflow_ button.
295295
Click on the button and select the branch that you want to test.
296-
6. Test if the notebook works in [https://mybinder.org/](Binder) and if so, add _Launch Binder_ badges
296+
6. Test if the notebook works in [Binder](https://mybinder.org/) and if so, add _Launch Binder_ badges
297297
to the README files.
298298

299299
Once your notebook passes in the CI and you have verified that everything looks good, make a Pull Request!

0 commit comments

Comments
 (0)