Skip to content

Commit

Permalink
Initial feedback placeholder
Browse files Browse the repository at this point in the history
  • Loading branch information
Neeratyoy Mallik committed May 28, 2024
1 parent 8249c58 commit 66d71c3
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,14 @@ To maintain consistency and readability, we follow a set of code style and guide
- Write comprehensive and meaningful commit messages.
- Write unit tests for new features and ensure existing tests pass.

## Documentation

TODO.
<!--
Instructions on where to add docstrings/comments and how to render docs locally for debugging.
Add guide on when documentation is must and how.
-->

## Community Guidelines

When participating in the DEHB community, please adhere to the following guidelines:
Expand Down
5 changes: 4 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,10 @@ pip install dehb
DEHB allows users to either utilize the Ask & Tell interface for manual task distribution or leverage the built-in functionality (`run`) to set up a Dask cluster autonomously. Please refer to our [Getting Started](getting_started/single_worker.md) examples.

## Contributing
Please have a look at our [contributing guidelines](https://github.com/automl/DEHB/blob/master/CONTRIBUTING.md).
Please have a look at our [contributing guidelines](../CONTRIBUTING.md).
<!--
TODO: Check if this renders in the github.io docs
-->

## To cite the paper or code
If you use DEHB in one of your research projects, please cite our paper(s):
Expand Down

0 comments on commit 66d71c3

Please sign in to comment.