docs: create projet documentation

Author: erwanschild

CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+
+<!-- insertion marker -->

CODE_OF_CONDUCT.md

@@ -0,0 +1,54 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+
+* Being respectful of differing viewpoints and experiences
+
+* Gracefully accepting constructive criticism
+
+* Focusing on what is best for the community
+
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+
+* Trolling, insulting/derogatory comments, and personal or political attacks
+
+* Public or private harassment
+
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at erwan.schild@e-i.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,183 @@
+# Contributing
+
+Contributions are welcome, and they are greatly appreciated!
+Every little bit helps, and credit will always be given.
+
+## Environment setup
+
+Nothing easier!
+Follow the instructions below.
+
+!!! note
+    We **STRONGLY** recommend using a Linux distribution for Python development (Windows sometimes leads to obscure compatibility errors...)
+
+
+1. Install [`Git`](https://git-scm.com/) to version and track our software changes.
+
+    - On _Windows_, use the official installer: [`Git-for-Windows`](https://git-scm.com/download/win).
+
+    - On _Linux_, simply use your package manager.
+
+    !!! note
+        `Git-for-Windows` doesn't provide the command `make`. In following step, use `pdm` instead.
+
+
+1. Install [`Python`](https://www.python.org/) as programming language for this projet.
+
+    - On _Windows_, use the official installer: [Python Releases for Windows](https://www.python.org/downloads/windows/).
+
+    - On _Linux_, simply use your package manager.
+
+    !!! note
+        You can also use use [`pyenv`](https://github.com/pyenv/pyenv).
+
+        ```bash
+        # install pyenv
+        git clone https://github.com/pyenv/pyenv ~/.pyenv
+
+        # setup pyenv (you should also put these three lines in .bashrc or similar)
+        export PATH="${HOME}/.pyenv/bin:${PATH}"
+        export PYENV_ROOT="${HOME}/.pyenv"
+        eval "$(pyenv init -)"
+
+        # install Python 3.8
+        pyenv install 3.8
+
+        # make it available globally
+        pyenv global system 3.8
+        ```
+
+
+1. Fork and clone the repository:
+
+    ```bash
+    git clone https://github.com/cognitivefactory/features-maximization-metric/
+    cd features-maximization-metric
+    ```
+
+
+1. Install the dependencies of the projet with:
+
+    ```bash
+    cd interactive-clustering
+    make setup # on Linux
+    pdm install # on Windows
+    ```
+
+    !!! note
+        If it fails for some reason (especially on Windows), you'll need to install [`pipx`](https://github.com/pypa/pipx) and [`pdm`](https://github.com/pdm-project/pdm) manually.
+
+        You can install them with:
+
+        ```bash
+        python3 -m pip install --user pipx
+        pipx install pdm
+        ```
+
+        Now you can try running `make setup` again, or simply `pdm install`.
+
+Your project is now ready and dependencies are installed.
+
+
+## Available template tasks
+
+This project uses [duty](https://github.com/pawamoy/duty) to run tasks.
+A Makefile is also provided.
+To run a task, use `make TASK` on _Linux_ and `pdm run duty TASK` _on Windows_.
+
+To show the available template task:
+
+```bash
+make help # on Linux
+pdm run duty --list # on Windows
+```
+
+The Makefile will try to run certain tasks on multiple Python versions.
+If for some reason you don't want to run the task on multiple Python versions, you can do one of the following:
+
+1. `export PYTHON_VERSIONS= `: this will run the task
+   with only the current Python version
+2. run the task directly with `pdm run duty TASK`
+
+The Makefile detects if a virtual environment is activated, so `make`/`pdm` will work the same with the virtualenv activated or not.
+
+## Development journey
+
+As usual:
+
+1. create a new branch: `git checkout -b feature-or-bugfix-name`
+1. edit the code and/or the documentation
+
+If you updated the documentation or the project dependencies:
+
+1. run `make docs-regen`
+1. run `make docs-serve`, go to http://localhost:8000 and check that everything looks good
+
+**Before committing:**
+
+1. run `make format` to auto-format the code
+1. run `make check` to check everything (fix any warning)
+1. run `make test` to run the tests (fix any issue)
+1. follow our [commit message convention](#commit-message-convention)
+
+If you are unsure about how to fix or ignore a warning, just let the continuous integration fail, and we will help you during review.
+
+Don't bother updating the changelog, we will take care of this.
+
+## Commit message convention
+
+Commits messages must follow the [Angular style](https://gist.github.com/stephenparish/9941e89d80e2bc58a153#format-of-the-commit-message):
+
+```
+<type>[(scope)]: Subject
+
+[Body]
+```
+
+Scope and body are optional. Type can be:
+
+- `build`: About packaging, building wheels, etc.
+- `chore`: About packaging or repo/files management.
+- `ci`: About Continuous Integration.
+- `docs`: About documentation.
+- `feat`: New feature.
+- `fix`: Bug fix.
+- `perf`: About performance.
+- `refactor`: Changes which are not features nor bug fixes.
+- `style`: A change in code style/format.
+- `tests`: About tests.
+
+**Subject (and body) must be valid Markdown.**
+If you write a body, please add issues references at the end:
+
+```
+Body.
+
+References: #10, #11.
+Fixes #15.
+```
+
+## Pull requests guidelines
+
+Link to any related issue in the Pull Request message.
+
+During review, we recommend using fixups:
+
+```bash
+# SHA is the SHA of the commit you want to fix
+git commit --fixup=SHA
+```
+
+Once all the changes are approved, you can squash your commits:
+
+```bash
+git rebase -i --autosquash master
+```
+
+And force-push:
+
+```bash
+git push -f
+```
+
+If this seems all too complicated, you can push or force-push each new commit, and we will squash them ourselves if needed, before merging.