From 3fc0c10c49765dd7f736603e21a7f6e95f7b2d90 Mon Sep 17 00:00:00 2001 From: y0z Date: Fri, 13 Dec 2024 11:50:55 +0900 Subject: [PATCH 1/3] Add instrunction not to use HTML tags in README.md --- recipes/002_registration.py | 2 ++ template/README.md | 8 +++++--- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/recipes/002_registration.py b/recipes/002_registration.py index 3e554714..e36b7f0a 100644 --- a/recipes/002_registration.py +++ b/recipes/002_registration.py @@ -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. diff --git a/template/README.md b/template/README.md index 2ef91a7a..018df063 100644 --- a/template/README.md +++ b/template/README.md @@ -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) + +- 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. +- **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 From 3104dc51765c0c9f224e2ae8d7c571725c681243 Mon Sep 17 00:00:00 2001 From: Shuhei Watanabe <47781922+nabenabe0928@users.noreply.github.com> Date: Tue, 17 Dec 2024 10:47:14 +0100 Subject: [PATCH 2/3] Update template/README.md --- template/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/template/README.md b/template/README.md index 018df063..0f29e0da 100644 --- a/template/README.md +++ b/template/README.md @@ -30,7 +30,7 @@ license: "MIT License" Instruction (you can remove this instruction when you write the `README.md` for your package) - 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. +- Looking at [other packages' implementations](https://github.com/optuna/optunahub-registry/tree/main/package) would also be helpful. - **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 From 623ae331870e6f8ad67ecf56e5499250c2df06bd Mon Sep 17 00:00:00 2001 From: Shuhei Watanabe <47781922+nabenabe0928@users.noreply.github.com> Date: Tue, 17 Dec 2024 10:47:20 +0100 Subject: [PATCH 3/3] Update template/README.md --- template/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/template/README.md b/template/README.md index 0f29e0da..e2d31d6c 100644 --- a/template/README.md +++ b/template/README.md @@ -27,7 +27,7 @@ license: "MIT License" --- --> -Instruction (you can remove this instruction when you write the `README.md` for your package) +Instruction (Please remove this instruction after you carefully read) - 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) would also be helpful.