diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..312dcf0ea --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,8 @@ +LightGBM has been developed and used by many active community members. Your help is very valuable to make it better for everyone. + +- Check for the [Roadmap](https://github.com/microsoft/LightGBM/projects/1) and the [Feature Requests Hub](https://github.com/microsoft/LightGBM/issues/2302), and submit pull requests to address chosen issue. If you need development guideline, you can check the [Development Guide](https://github.com/microsoft/LightGBM/blob/master/docs/Development-Guide.rst) or directly ask us in Issues/Pull Requests. +- Contribute to the [tests](https://github.com/microsoft/LightGBM/tree/master/tests) to make it more reliable. +- Contribute to the [documentation](https://github.com/microsoft/LightGBM/tree/master/docs) to make it clearer for everyone. +- Contribute to the [examples](https://github.com/microsoft/LightGBM/tree/master/examples) to share your experience with other users. +- Add your stories and experience to [Awesome LightGBM](https://github.com/microsoft/LightGBM/blob/master/examples/README.md). If LightGBM helped you in a machine learning competition or some research application, we want to hear about it! +- [Open an issue](https://github.com/microsoft/LightGBM/issues) to report problems or recommend new features. diff --git a/README.md b/README.md index 9dc32cf1f..5b84ebfa9 100644 --- a/README.md +++ b/README.md @@ -94,14 +94,8 @@ Support How to Contribute ----------------- -LightGBM has been developed and used by many active community members. Your help is very valuable to make it better for everyone. +Check [CONTRIBUTING](https://github.com/microsoft/LightGBM/blob/master/CONTRIBUTING.md) page. -- Contribute to the [tests](https://github.com/microsoft/LightGBM/tree/master/tests) to make it more reliable. -- Contribute to the [documentation](https://github.com/microsoft/LightGBM/tree/master/docs) to make it clearer for everyone. -- Contribute to the [examples](https://github.com/microsoft/LightGBM/tree/master/examples) to share your experience with other users. -- Look for [issues with tag "help wanted"](https://github.com/microsoft/LightGBM/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) and submit pull requests to address them. -- Add your stories and experience to [Awesome LightGBM](https://github.com/microsoft/LightGBM/blob/master/examples/README.md). If LightGBM helped you in a machine learning competition or some research application, we want to hear about it! -- [Open an issue](https://github.com/microsoft/LightGBM/issues) to report problems or recommend new features. Microsoft Open Source Code of Conduct ------------------------------------- diff --git a/docs/Development-Guide.rst b/docs/Development-Guide.rst index d7446ca2e..6a5521b82 100644 --- a/docs/Development-Guide.rst +++ b/docs/Development-Guide.rst @@ -27,7 +27,7 @@ Important Classes +-------------------------+----------------------------------------------------------------------------------------+ | ``DatasetLoader`` | Used to construct dataset | +-------------------------+----------------------------------------------------------------------------------------+ -| ``Feature`` | Stores one column feature | +| ``FeatureGroup`` | Stores the data of feature, could be multiple features | +-------------------------+----------------------------------------------------------------------------------------+ | ``Metric`` | Evaluation metrics | +-------------------------+----------------------------------------------------------------------------------------+