Skip to content

Commit 0d4603c

Browse files
authored
Merge pull request #356 from y0z/feature/code-review-standards
Add code review standards
2 parents 13c4c1e + 2d64e88 commit 0d4603c

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
If you are interested in contributing to Optuna Hub, please read the following guidelines.
44
If you are new to GitHub, please refer to [our blog](https://medium.com/optuna/optuna-wants-your-pull-request-ff619572302c) for more information.
55

6+
## Tutorial
7+
8+
You can find tutorials to implement a package for the OptunaHub registry in [Tutorials for Contributors](https://optuna.github.io/optunahub/tutorials_for_contributors.html).
9+
610
## Coding Standards and Guidelines
711

812
Please adhere to the following coding standards and guidelines:
@@ -37,9 +41,20 @@ Second, the **description** of your pull request should:
3741

3842
Finally, read [`contributor agreements`](#contributor-agreements) and if you agree, please click the checkbox
3943

40-
## Tutorial
44+
## Code Review Standards
4145

42-
You can find tutorials to implement a package for the OptunaHub registry in [Tutorials for Contributors](https://optuna.github.io/optunahub/tutorials_for_contributors.html).
46+
All contributions must undergo code review and approval by at least one OptunaHub committer before being merged. Package development and long-term maintenance are primarily the responsibility of contributors. OptunaHub committers only ensure compliance with submission standards.
47+
48+
In general, contributions are expected to satisfy the following requirements:
49+
50+
1. **Minimal Working Example**\
51+
For new package registrations or updates, a minimal working example demonstrating basic functionality must be provided. This may be included in the pull request description, the package’s `README.md`, or a separate file such as `example.py`. Adding [unit tests](https://optuna.github.io/optunahub/generated/recipes/008_unit_tests.html) is strongly encouraged but not mandatory. Providing benchmark results is also welcome.
52+
53+
1. **Security and Safety**\
54+
Contributions must be free of malicious code. For security reasons, binary files (except images used in `README.md`) cannot be distributed directly through the `optunahub-registry`. If binary dependencies are required, they should be hosted separately (e.g., on PyPI) and declared appropriately.
55+
56+
1. **Engineering and Scientific Integrity**\
57+
Contributors are expected to adhere to sound engineering and scientific practices, including compliance with applicable software licenses. OptunaHub does not perform peer review of scientific validity; responsibility for the correctness and validity of methods remains with contributors. However, submissions that clearly violate research ethics, contain misleading claims, or demonstrate harmful or malicious intent may be declined or removed at the discretion of the OptunaHub committers. Community discussion via linked GitHub issues is encouraged to promote transparency and critical evaluation of contributed methods.
4358

4459
## Contributor Agreements
4560

0 commit comments

Comments
 (0)