Skip to content

Commit

Permalink
Merge pull request #114 from nabenabe0928/reflect-feedback
Browse files Browse the repository at this point in the history
Enhance PR template
  • Loading branch information
y0z authored Jul 30, 2024
2 parents f2a79e2 + 3833f57 commit 9008ead
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 1 deletion.
25 changes: 24 additions & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,30 @@

Please read the [contributor agreements](https://github.com/optuna/optunahub-registry/blob/main/CONTRIBUTING.md#contributor-agreements) and if you agree, please click the checkbox below.

- \[ \] I agree to the contributor agreements.
- [ ] I agree to the contributor agreements.

> [!IMPORTANT]
> The following formatting is a requirement to merge this PR:
>
> ```shell
> $ pip install pre-commit
> $ pre-commit run --all-files
> ```
>
> Please also try the following to make sure that your module can be loaded from the registry:
>
> ```python
> import optunahub
>
> module = optunahub.load_module(
> # category is one of [pruners, samplers, visualization].
> package="<category>/<your_package_name>",
> repo_owner="<your_github_id>",
> ref="<your_branch_name>",
> )
> ```
>
> For more detail, please check [the tutorial](https://optuna.github.io/optunahub-registry/recipes/005_debugging.html).
## Motivation
Expand Down
1 change: 1 addition & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,4 @@ repos:
- id: mdformat
additional_dependencies:
- mdformat-frontmatter
exclude: .github/

0 comments on commit 9008ead

Please sign in to comment.