From ab1cee7568340900819f1f2bdbd095e21edef9ed Mon Sep 17 00:00:00 2001 From: VincentAuriau Date: Thu, 2 May 2024 11:58:34 +0200 Subject: [PATCH] ADD: contribution guidelines --- CONTRIBUTING.md | 3 +++ README.md | 11 +++++++++++ 2 files changed, 14 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..3d113817 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,3 @@ +# Contributing to Choice-Learn + +You are more than welcome to propose and contribute to new developments. We encourage you to open an [issue](https://github.com/artefactory/choice-learn-private/issues) so that we can discuss your different ideas. diff --git a/README.md b/README.md index 66023aaf..783e1e17 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,7 @@ Choice-Learn uses NumPy and pandas as data backend engines and TensorFlow for mo - [Installation](#installation) - [Usage](#usage) - [Documentation](#documentation) + - [Contributing](#contributing) - [Citation](#citation) ## Introduction - Discrete Choice Modelling @@ -152,6 +153,16 @@ print(model.report) A detailed documentation of this project is available [here](https://artefactory.github.io/choice-learn-private/). +## Contributing +You are welcome to contribute to the project ! You can help in various ways: +- raise issues +- resolve issues already opened +- develop new features +- fix typos, improve code quality +- develop new tests + +We recommend to open an [issue](https://github.com/artefactory/choice-learn-private/issues) to discuss your ideas. More details are given [here](./CONTRIBUTING.md). + ## Citation If you consider this package and any of its feature useful for your research, please cite our paper: