Skip to content

Commit f97c233

Browse files
authored
Update Contribute (#741)
1 parent c01e65b commit f97c233

File tree

3 files changed

+34
-7
lines changed

3 files changed

+34
-7
lines changed

website/docs/Contribute.md

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Contributing
22

3-
This project welcomes (and encourages) all forms of contributions, including but not limited to:
3+
This project welcomes and encourages all forms of contributions, including but not limited to:
44

55
- Pushing patches.
66
- Code review of pull requests.
77
- Documentation, examples and test cases.
88
- Readability improvement, e.g., improvement on docstr and comments.
9-
- Community participation in [issues](https://github.com/microsoft/FLAML/issues), [discussions](https://github.com/microsoft/FLAML/discussions), and [gitter](https://gitter.im/FLAMLer/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge).
9+
- Community participation in [issues](https://github.com/microsoft/FLAML/issues), [discussions](https://github.com/microsoft/FLAML/discussions), and [discord](https://discord.gg/7ZVfhbTQZ5).
1010
- Tutorials, blog posts, talks that promote the project.
1111
- Sharing application scenarios and/or related research.
1212

@@ -26,6 +26,31 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
2626
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
2727
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
2828

29+
## How to make a good bug report
30+
31+
When you submit an issue to [GitHub](https://github.com/microsoft/FLAML/issues), please do your best to
32+
follow these guidelines! This will make it a lot easier to provide you with good
33+
feedback:
34+
35+
- The ideal bug report contains a short reproducible code snippet. This way
36+
anyone can try to reproduce the bug easily (see [this](https://stackoverflow.com/help/mcve) for more details). If your snippet is
37+
longer than around 50 lines, please link to a [gist](https://gist.github.com) or a GitHub repo.
38+
39+
- If an exception is raised, please **provide the full traceback**.
40+
41+
- Please include your **operating system type and version number**, as well as
42+
your **Python, flaml, scikit-learn versions**. The version of flaml
43+
can be found by running the following code snippet:
44+
```python
45+
import flaml
46+
print(flaml.__version__)
47+
```
48+
49+
- Please ensure all **code snippets and error messages are formatted in
50+
appropriate code blocks**. See [Creating and highlighting code blocks](https://help.github.com/articles/creating-and-highlighting-code-blocks)
51+
for more details.
52+
53+
2954
## Becoming a Reviewer
3055

3156
There is currently no formal reviewer solicitation process. Current reviewers identify reviewers from active contributors. If you are willing to become a reviewer, you are welcome to let us know on gitter.
@@ -68,7 +93,6 @@ coverage run -m pytest test
6893

6994
Then you can see the coverage report by
7095
`coverage report -m` or `coverage html`.
71-
If all the tests are passed, please also test run [notebook/automl_classification](https://github.com/microsoft/FLAML/blob/main/notebook/automl_classification.ipynb) to make sure your commit does not break the notebook example.
7296

7397
### Documentation
7498

@@ -91,3 +115,6 @@ yarn start
91115

92116
The last command starts a local development server and opens up a browser window.
93117
Most changes are reflected live without having to restart the server.
118+
119+
Note:
120+
some tips in this guide are based off the contributor guide from [ray](https://docs.ray.io/en/latest/ray-contribute/getting-involved.html), [scikit-learn](https://scikit-learn.org/stable/developers/contributing.html), or [hummingbird](https://github.com/microsoft/hummingbird/blob/main/CONTRIBUTING.md).

website/docs/Getting-Started.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,3 +95,5 @@ Then, you can use it just like you use the original `LGMBClassifier`. Your other
9595
* Refer to [SDK](reference/automl) and [FAQ](FAQ).
9696

9797
If you like our project, please give it a [star](https://github.com/microsoft/FLAML/stargazers) on GitHub. If you are interested in contributing, please read [Contributor's Guide](Contribute).
98+
99+
<iframe src="https://ghbtns.com/github-btn.html?user=microsoft&amp;repo=FLAML&amp;type=star&amp;count=true&amp;size=large" frameborder="0" scrolling="0" width="170" height="30" title="GitHub"></iframe>

website/docs/Research.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Research in FLAML
1+
# Research
22

33
For technical details, please check our research publications.
44

@@ -17,7 +17,5 @@ For technical details, please check our research publications.
1717
* [Economical Hyperparameter Optimization With Blended Search Strategy](https://www.microsoft.com/en-us/research/publication/economical-hyperparameter-optimization-with-blended-search-strategy/). Chi Wang, Qingyun Wu, Silu Huang, Amin Saied. ICLR 2021.
1818
* [An Empirical Study on Hyperparameter Optimization for Fine-Tuning Pre-trained Language Models](https://aclanthology.org/2021.acl-long.178.pdf). Susan Xueqing Liu, Chi Wang. ACL 2021.
1919
* [ChaCha for Online AutoML](https://www.microsoft.com/en-us/research/publication/chacha-for-online-automl/). Qingyun Wu, Chi Wang, John Langford, Paul Mineiro and Marco Rossi. ICML 2021.
20-
* [Fair AutoML](https://arxiv.org/abs/2111.06495). Qingyun Wu, Chi Wang. ArXiv preprint arXiv:2111.06495 (2021).
20+
* [Fair AutoML](https://arxiv.org/abs/2111.06495). Qingyun Wu, Chi Wang. ArXiv preprint arXiv:2111.06495 (2021).
2121
* [Mining Robust Default Configurations for Resource-constrained AutoML](https://arxiv.org/abs/2202.09927). Moe Kayali, Chi Wang. ArXiv preprint arXiv:2202.09927 (2022).
22-
23-
Many researchers and engineers have contributed to the technology development. In alphabetical order: Vijay Aski, Sebastien Bubeck, Surajit Chaudhuri, Kevin Chen, Yi Wei Chen, Nadiia Chepurko, Ofer Dekel, Alex Deng, Anshuman Dutt, Nicolo Fusi, Jianfeng Gao, Johannes Gehrke, Niklas Gustafsson, Silu Huang, Moe Kayali, Dongwoo Kim, Christian Konig, John Langford, Menghao Li, Mingqin Li, Susan Xueqing Liu, Zhe Liu, Naveen Gaur, Paul Mineiro, Vivek Narasayya, Jake Radzikowski, Marco Rossi, Amin Saied, Neil Tenenholtz, Olga Vrousgou, Chi Wang, Yue Wang, Markus Weimer, Qingyun Wu, Qiufeng Yin, Haozhe Zhang, Minjia Zhang, XiaoYun Zhang, Eric Zhu, Rui Zhuang.

0 commit comments

Comments
 (0)