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

Jump to bottom

Initial feedback push #89

Closed
wants to merge 1 commit into from
Closed

Initial feedback push #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
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
View file
Open in desktop
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