Skip to content
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

Add instrunctions not to use HTML tags in README.md #211

Merged
merged 3 commits into from
Dec 17, 2024
Merged

Add instrunctions not to use HTML tags in README.md #211

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3fc0c10
Add instrunction not to use HTML tags in README.md
y0z Dec 13, 2024
3104dc5
Update template/README.md
nabenabe0928 Dec 17, 2024
623ae33
Update template/README.md
nabenabe0928 Dec 17, 2024
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
2 changes: 2 additions & 0 deletions recipes/002_registration.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,8 @@
- [Original Paper](Link/to/the/original/paper)
- [Source Code](Link/to/the/source/code)
Please do not use HTML tags in the README.md file. Only markdown is allowed. For security reasons, the HTML tags will be removed when the package is registered on the web page.
It is highly recommended that you confirm your package works properly (cf. :doc:`005_debugging`) before making a pull request.
Before making a pull request, please ensure the code examples in ``README.md`` and example.py do not contain your local directory and/or your fork of the registry.
Expand Down
8 changes: 5 additions & 3 deletions template/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,11 @@ license: "MIT License"
---
-->

Please read the [tutorial guide](https://optuna.github.io/optunahub-registry/recipes/001_first.html) to register your feature in OptunaHub.
You can find more detailed explanation of the following contents in the tutorial.
Looking at [other packages' implementations](https://github.com/optuna/optunahub-registry/tree/main/package) will also help you.
Instruction (you can remove this instruction when you write the `README.md` for your package)
nabenabe0928 marked this conversation as resolved.
Show resolved Hide resolved

- Please read the [tutorial guide](https://optuna.github.io/optunahub-registry/recipes/001_first.html) to register your feature in OptunaHub. You can find more detailed explanation of the following contents in the tutorial.
- Looking at [other packages' implementations](https://github.com/optuna/optunahub-registry/tree/main/package) will also help you.
nabenabe0928 marked this conversation as resolved.
Show resolved Hide resolved
- **Please do not use HTML tags in the `README.md` file. Only markdown is allowed. For security reasons, the HTML tags will be removed when the package is registered on the web page.**

## Abstract

Expand Down
Loading