From 66d71c30275645ecf26327e96093435294a0130f Mon Sep 17 00:00:00 2001 From: Neeratyoy Mallik Date: Tue, 28 May 2024 17:23:54 +0200 Subject: [PATCH] Initial feedback placeholder --- CONTRIBUTING.md | 8 ++++++++ docs/index.md | 5 ++++- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 10dc4de..9cdb697 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. + + ## Community Guidelines When participating in the DEHB community, please adhere to the following guidelines: diff --git a/docs/index.md b/docs/index.md index 5fa3ae4..df1348d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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). + ## To cite the paper or code If you use DEHB in one of your research projects, please cite our paper(s):