Skip to content

Commit f9073e8

Browse files
committed
Fix in README to provide valid markdown checklist
1 parent 9a130b4 commit f9073e8

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md.jinja

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,35 +18,35 @@ Please ensure to execute the following steps. The steps are also indicated with
1818
TODO statements in the generated code - so you can also simply search the
1919
code for TODO instead of following the checklist below.
2020

21-
- [] Include a URL to your code repository in setup.py.
22-
- [] Implement your algorithm functions.
23-
- [] You are free to add more arguments to the functions. Be sure to add them
21+
- [ ] Include a URL to your code repository in setup.py.
22+
- [ ] Implement your algorithm functions.
23+
- [ ] You are free to add more arguments to the functions. Be sure to add them
2424
*after* the `client` and dataframe arguments.
25-
- [] When adding new arguments, if you run the `test/test.py` script, be sure
25+
- [ ] When adding new arguments, if you run the `test/test.py` script, be sure
2626
to include values for these arguments in the `client.task.create()` calls
2727
that are available there.
28-
- [] If you are using Python packages that are not in the standard library, add
28+
- [ ] If you are using Python packages that are not in the standard library, add
2929
them to the `requirements.txt` and `setup.py` file.
3030
{% if has_docs %}
31-
- [] Fill in the documentation template. This will help others to understand your
31+
- [ ] Fill in the documentation template. This will help others to understand your
3232
algorithm, be able to use it safely, and to contribute to it.
3333
{% else %}
34-
- [] We strongly recommend adding documentation to your code. This will help
34+
- [ ] We strongly recommend adding documentation to your code. This will help
3535
others to understand your code and will help you to understand your own code
3636
in the future.
3737
{% endif %}
38-
- [] If you want to submit your algorithm to a vantage6 algorithm store, be sure
38+
- [ ] If you want to submit your algorithm to a vantage6 algorithm store, be sure
3939
to fill in everything in ``algorithm_store.json`` (and be sure to update
4040
it if you change function names, arguments, etc.).
4141
{% if has_gh_pipeline %}
42-
- [] Create a ``DOCKER_USER`` and ``DOCKER_PASSWORD`` secret in the GitHub repository
42+
- [ ] Create a ``DOCKER_USER`` and ``DOCKER_PASSWORD`` secret in the GitHub repository
4343
settings. This will be used to push the Docker image to the registry in the github
4444
pipeline.
4545
{% endif %}
4646
{% if use_vpn %}
47-
- [] Review the EXPOSE and LABEL commands in the Dockerfile for VPN
47+
- [ ] Review the EXPOSE and LABEL commands in the Dockerfile for VPN
4848
{% endif %}
49-
- [] Finally, remove this checklist section to keep the README clean.
49+
- [ ] Finally, remove this checklist section to keep the README clean.
5050

5151
### Dockerizing your algorithm
5252

0 commit comments

Comments
 (0)