Improve contributing guide, add an AI-assisted policy and a code of conduct

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,72 @@
+name: 🐞 Bug report
+description: Something in ProxSuite is not working the way it should
+title: "[Bug]: bug title"
+labels: ["bug"]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Follow the [contributing guidelines](../../development/contributing.md).
+
+        If you have a question about how to use ProxSuite, open a [discussion](https://github.com/Simple-Robotics/proxsuite/discussions).
+
+  - type: textarea
+    id: description
+    attributes:
+      label: 🐞 Bug
+      description: A clear and concise description of what the bug is.
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: Reproduction steps
+      description: |
+        Steps to reproduce the behavior. Provide a minimal example that reproduces the bug
+        and a Dockerfile if it's an installation issue. Error messages and stack traces are also helpful.
+        Use [Markdown code blocks](https://help.github.com/en/articles/creating-and-highlighting-code-blocks) for code and stack traces.
+      value: |
+        ```python
+        import proxsuite
+        ```
+
+  - type: textarea
+    id: traceback
+    attributes:
+      label: Relevant log output / Error message
+      description: Copy and paste any relevant log output or error message.
+      placeholder: Segmentation fault...
+      render: shell
+
+  - type: textarea
+    id: system-info
+    attributes:
+      label: System Info
+      description: |
+        Describe the characteristics of your environment:
+         * OS
+         * Package manager used
+         * proxsuite version or SHA1 if built from source
+         * All dependency versions
+         * Compiler
+         * CMake arguments
+         * CMake output
+
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Checklist
+      options:
+        - label: I have checked that all my packages are installed from the same package manager (conda-forge, Nix, PyPI, robotpkg, ROS, ...)
+          required: true
+        - label: I have checked that there is no similar [issue](https://github.com/Simple-Robotics/proxsuite/issues)/[discussion](https://github.com/Simple-Robotics/proxsuite/discussions)
+            in the repo
+          required: true
+        - label: I have provided a minimal and working example to reproduce the bug
+          required: true
+        - label: I have used [Markdown code blocks](https://help.github.com/en/articles/creating-and-highlighting-code-blocks) for code, stack traces and
+            compiler errors
+          required: true
+        - label: I have used an AI assistant

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,49 @@
+name: 💡 Feature request
+description: Suggest an idea to improve ProxSuite
+title: "[Feature]: feature title"
+labels: ["feature request"]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Follow the [contributing guidelines](../../development/contributing.md).
+
+        If you have a question about how to use ProxSuite, open a [discussion](https://github.com/Simple-Robotics/proxsuite/discussions).
+
+  - type: textarea
+    id: description
+    attributes:
+      label: 🚀 Feature
+      description: A clear and concise description of the feature proposal.
+    validations:
+      required: true
+
+  - type: textarea
+    id: motivation
+    attributes:
+      label: Motivation
+      description: Outline the motivation for the proposal. Is the request related to a problem? For example, "I'm always frustrated when [...]". If it
+        is related to another GitHub issue, link it here.
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives
+      description: A clear and concise description of the alternative solutions or features you considered.
+
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots about the feature request here.
+
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Checklist
+      options:
+        - label: I have checked that there is no similar [issue](https://github.com/Simple-Robotics/proxsuite/issues)/[discussion](https://github.com/Simple-Robotics/proxsuite/discussions)
+            in the repo
+          required: true
+        - label: I have used an AI assistant

.github/pull_request_template.md

@@ -0,0 +1,24 @@
+<!--
+Follow the [contributing guidelines](../development/contributing.md).
+-->
+
+## Description
+
+<!--
+Describe the changes included in this pull request.
+Explain what you change and why.
+
+If the pull request fixes an issue, link it with "Fixes #issue_number".
+-->
+
+## Checklist
+
+- [ ] I have read the [contributing guidelines](../development/contributing.md)
+- [ ] I have run `pre-commit run --all-files` or `pixi run lint`
+- [ ] I have reviewed my own code
+- [ ] I have commented my code where necessary
+- [ ] I have made corresponding changes to the Doxygen documentation
+- [ ] I have added tests that prove my fix or feature works
+- [ ] I have updated the [CHANGELOG](https://github.com/Simple-Robotics/proxsuite/blob/devel/CHANGELOG.md) or added the "no changelog" label for CI or infra changes
+- [ ] I have updated the [README credits section](https://github.com/Simple-Robotics/proxsuite?tab=readme-ov-file#credits)
+- [ ] I have used an AI assistant

.gitignore

@@ -1,4 +1,4 @@
-build*
+build/*
 Xcode*
 *.pyc
 .vscode*

CODE_OF_CONDUCT.md

@@ -0,0 +1,89 @@
+
+# Contributor Covenant 3.0 Code of Conduct
+
+## Our Pledge
+
+We pledge to make our community welcoming, safe, and equitable for all.
+
+We are committed to fostering an environment that respects and promotes the dignity, rights, and contributions of all individuals, regardless of characteristics including race, ethnicity, caste, color, age, physical characteristics, neurodiversity, disability, sex or gender, gender identity or expression, sexual orientation, language, philosophy or religion, national or social origin, socio-economic position, level of education, or other status. The same privileges of participation are extended to everyone who participates in good faith and in accordance with this Covenant.
+
+## Encouraged Behaviors
+
+While acknowledging differences in social norms, we all strive to meet our community's expectations for positive behavior. We also understand that our words and actions may be interpreted differently than we intend based on culture, background, or native language.
+
+With these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including:
+
+1. Respecting the **purpose of our community**, our activities, and our ways of gathering.
+2. Engaging **kindly and honestly** with others.
+3. Respecting **different viewpoints** and experiences.
+4. **Taking responsibility** for our actions and contributions.
+5. Gracefully giving and accepting **constructive feedback**.
+6. Committing to **repairing harm** when it occurs.
+7. Behaving in other ways that promote and sustain the **well-being of our community**.
+
+
+## Restricted Behaviors
+
+We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct.
+
+1. **Harassment.** Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop.
+2. **Character attacks.** Making insulting, demeaning, or pejorative comments directed at a community member or group of people.
+3. **Stereotyping or discrimination.** Characterizing anyone’s personality or behavior on the basis of immutable identities or traits.
+4. **Sexualization.** Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community.
+5. **Violating confidentiality**. Sharing or acting on someone's personal or private information without their permission.
+6. **Endangerment.** Causing, encouraging, or threatening violence or other harm toward any person or group.
+7. Behaving in other ways that **threaten the well-being** of our community.
+
+### Other Restrictions
+
+1. **Misleading identity.** Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions.
+2. **Failing to credit sources.** Not properly crediting the sources of content you contribute.
+3. **Promotional materials**. Sharing marketing or other commercial content in a way that is outside the norms of the community.
+4. **Irresponsible communication.** Failing to responsibly present content which includes, links or describes any other restricted behaviors.
+
+
+## Reporting an Issue
+
+Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm.
+
+When an incident does occur, it is important to report it promptly. To report a possible violation, **send an email to simple-robotics-contact@inria.fr**
+
+Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution.
+
+
+## Addressing and Repairing Harm
+
+If an investigation by the Community Moderators finds that this Code of Conduct has been violated, the following enforcement ladder may be used to determine how best to repair harm, based on the incident's impact on the individuals involved and the community as a whole. Depending on the severity of a violation, lower rungs on the ladder may be skipped.
+
+1) Warning
+   1) Event: A violation involving a single incident or series of incidents.
+   2) Consequence: A private, written warning from the Community Moderators.
+   3) Repair: Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations.
+2) Temporarily Limited Activities
+   1) Event: A repeated incidence of a violation that previously resulted in a warning, or the first incidence of a more serious violation.
+   2) Consequence: A private, written warning with a time-limited cooldown period designed to underscore the seriousness of the situation and give the community members involved time to process the incident. The cooldown period may be limited to particular communication channels or interactions with particular community members.
+   3) Repair: Examples of repair may include making an apology, using the cooldown period to reflect on actions and impact, and being thoughtful about re-entering community spaces after the period is over.
+3) Temporary Suspension
+   1) Event: A pattern of repeated violation which the Community Moderators have tried to address with warnings, or a single serious violation.
+   2) Consequence: A private written warning with conditions for return from suspension. In general, temporary suspensions give the person being suspended time to reflect upon their behavior and possible corrective actions.
+   3) Repair: Examples of repair include respecting the spirit of the suspension, meeting the specified conditions for return, and being thoughtful about how to reintegrate with the community when the suspension is lifted.
+4) Permanent Ban
+   1) Event: A pattern of repeated code of conduct violations that other steps on the ladder have failed to resolve, or a violation so serious that the Community Moderators determine there is no way to keep the community safe with this person as a member.
+   2) Consequence: Access to all community spaces, tools, and communication channels is removed. In general, permanent bans should be rarely used, should have strong reasoning behind them, and should only be resorted to if working through other remedies has failed to change the behavior.
+   3) Repair: There is no possible repair in cases of this severity.
+
+This enforcement ladder is intended as a guideline. It does not limit the ability of Community Managers to use their discretion and judgment, in keeping with the best interests of our community.
+
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public or other spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+
+## Attribution
+
+This Code of Conduct is adapted from the Contributor Covenant, version 3.0, permanently available at [https://www.contributor-covenant.org/version/3/0/](https://www.contributor-covenant.org/version/3/0/).
+
+Contributor Covenant is stewarded by the Organization for Ethical Source and licensed under CC BY-SA 4.0. To view a copy of this license, visit [https://creativecommons.org/licenses/by-sa/4.0/](https://creativecommons.org/licenses/by-sa/4.0/)
+
+For answers to common questions about Contributor Covenant, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are provided at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations). Additional enforcement and community guideline resources can be found at [https://www.contributor-covenant.org/resources](https://www.contributor-covenant.org/resources). The enforcement ladder was inspired by the work of [Mozilla’s code of conduct team](https://github.com/mozilla/inclusion).

README.md

@@ -1,3 +1,5 @@
+# ProxSuite
+
 <p align="center">
   <img src="https://github.com/Simple-Robotics/proxsuite/raw/devel/doc/images/proxsuite-logo.png" width="700" alt="Proxsuite Logo" align="center"/>
 </p>
@@ -22,6 +24,28 @@ Through **ProxSuite**, we aim to offer the community scalable optimizers that de
 
 We are ready to integrate **ProxSuite** within other optimization ecosystems.
 
+## Table of contents
+- [ProxSuite](#proxsuite)
+   * [ProxSuite main features](#proxsuite-main-features)
+   * [Documentation](#documentation)
+   * [Getting started](#getting-started)
+      + [Quick install with <img src="https://www.python.org/static/community_logos/python-logo-inkscape.svg" height="30" style="vertical-align: -1em;">:](#quick-install-with-)
+      + [Quick install with <img src="https://s3.amazonaws.com/conda-dev/conda_logo.svg" height="18">:](#quick-install-with--1)
+      + [Quick install with <img src="https://brew.sh/assets/img/homebrew-256x256.png" height="30">:](#quick-install-with--2)
+      + [Alternative approaches](#alternative-approaches)
+      + [Compiling a first example program](#compiling-a-first-example-program)
+      + [Using ProxSuite with CMake](#using-proxsuite-with-cmake)
+   * [**ProxQP**](#proxqp)
+      + [Citing **ProxQP**](#citing-proxqp)
+      + [Numerical benchmarks](#numerical-benchmarks)
+   * [**QPLayer**](#qplayer)
+      + [Citing **QPLayer**](#citing-qplayer)
+   * [Installation procedure](#installation-procedure)
+   * [Contribution](#contribution)
+   * [Core-dev team](#core-dev-team)
+   * [Credits](#credits)
+
+
 ## ProxSuite main features
 
 **Proxsuite** is fast:
@@ -169,3 +193,41 @@ If you are using **QPLayer** for your work, we encourage you to [cite the relate
 ## Installation procedure
 
 Please follow the installation procedure [here](https://github.com/Simple-Robotics/proxsuite/blob/devel/doc/5-installation.md).
+
+## Contribution
+
+If you want to ask a question, report a bug, request a new feature or contributing with a pull requests please, follow the [contribution guideline](./development/contributing.md).
+
+## Core-dev team
+
+The currently active core developers of **ProxSuite** are:
+
+* [Justin Carpentier](https://jcarpent.github.io) (Inria): main developer and manager of the project
+* [Guilhem Saurel](https://github.com/nim65s) (LAAS-CNRS): core maintainer
+* [Joris Vailant](https://github.com/jorisv) (Inria): core developer and manager of the project
+* [Lucas Haubert](https://www.linkedin.com/in/lucas-haubert-b668a421a/) (Inria): core developer
+* [Fabian Schramm](https://github.com/fabinsch) (Inria): core developer
+* Sarah Kazdadi (Inria): core developer
+* [Jeanne Matheron](https://github.com/j-matheron) (Inria): core developer
+
+## Credits
+
+In addition to the core dev team, the following people have also been involved in the development of **ProxSuite** and are warmly thanked for their contributions:
+
+* [Antoine Bambade](https://bambade.github.io/) (Inria): main contributor of the dense solver and of **QPLayer**
+* [Wilson Jallet](https://manifoldfr.github.io/) (Inria): main contributor of the matrix-free solver and of the Julia bindings
+* [Stéphane Caron](https://scaron.info/) (Inria): for his early advices on proximal methods and his contributions to **ProxQP**
+* [Wolfgang Merkt](https://wxm.io/): for his advice on packaging and his contributions to the CI
+* [Quentin Le Lidec](https://quentinll.github.io/) (Inria): for his help on benchmarks
+* [Louis Montaut](https://github.com/lmontaut) (Inria): for his contributions to the documentation
+* [Adrien Escande](https://github.com/aescande) (Inria): for his contributions to the internal linear algebra utilities
+* Oumayma Bounou (Inria): for her contributions to the PyTorch interface of **QPLayer**
+* [Antoine Hoarau](https://github.com/ahoarau): for various contributions
+* [Joris Gillis](https://github.com/jgillis) (KU Leuven): for various contributions
+* Michael Fennel (KIT): for various contributions
+* Johannes Keustermans (Spectricity): for various contributions
+* J Berg: for various contributions
+* [Konstantinos Chatzilygeroudis](https://github.com/costashatz): for various contributions
+* [Daniel Morton](https://github.com/danielpmorton): for various contributions
+* [Daisuke Nishimatsu](https://github.com/wep21): for various contributions
+* Aaron Miller: for various contributions

development/build.md

@@ -0,0 +1,59 @@
+**Pixi will soon be available**
+
+# Build and develop with pixi
+
+The easiest way to set up a development environment is to use [pixi](https://pixi.sh/latest/#installation).
+
+[pixi](https://pixi.sh/latest/) is a cross-platform package manager for developers.
+It installs all required dependencies in the `.pixi` directory.
+It's used by our CI, so you get the same stable and tested dependencies.
+
+Run the following command to install dependencies, configure, build and test the project:
+
+```bash
+pixi run test
+```
+
+The project is built in the `build` directory.
+
+The typical workflow is:
+
+```bash
+pixi shell
+pixi run configure
+ninja -C build
+```
+
+After `pixi run configure`, use `cmake` and `ninja` manually to reconfigure and build the project.
+
+## Environments
+
+The pixi manifest contains many environments. The most common ones are:
+
+- **default**: core proxsuite
+- **all**: all proxsuite features
+
+To activate a specific environment, run:
+
+```bash
+pixi shell -e all
+```
+
+Using **all** makes it easy to choose which features to build.
+In this case, use the following CMake options:
+- `BUILD_WITH_CHOLMOD_SUPPORT` : Build ProxSuite with the Cholmod support
+- `BUILD_WITH_ACCELERATE_SUPPORT` : Build ProxSuite with the Accelerate support
+With the **all** environment, all these options are ON.
+To turn one off, pass the corresponding `-D` flag to `cmake`:
+
+```bash
+cmake -B build -DGENERATE_PYTHON_STUBS=OFF
+```
+
+## Faster build
+
+When you work on a single feature with one associated test,build and run the corresponding test:
+```bash
+ninja -C build proxsuite-test-cpp-<name>
+ctest --test-dir build --output-on-failure -R proxsuite-test-cpp-<name>
+```