Skip to content

Commit

Permalink
ADD: contribution guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
VincentAuriau committed May 2, 2024
1 parent eaeb7c0 commit ab1cee7
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down

0 comments on commit ab1cee7

Please sign in to comment.