From 238123d59beb03f244ef9b793fbd018d950705e0 Mon Sep 17 00:00:00 2001 From: Luca Date: Thu, 11 Jun 2026 22:28:59 +0100 Subject: [PATCH 1/2] code of conduct --- CODE_OF_CONDUCT.md | 85 ++++++++++++++++++++++++++++++++++++++++++++ docs/contributing.md | 28 +++++++++++++++ 2 files changed, 113 insertions(+) create mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..4745c8e --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,85 @@ + +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. + +Community leaders 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, and will communicate reasons for moderation decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at luca@quantmind.com. All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of actions. + +**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations + diff --git a/docs/contributing.md b/docs/contributing.md index dc1eb01..c2007bb 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -18,3 +18,31 @@ make install-dev ``` make tests ``` + +## Documentation + +Documentation is one of the areas where we most need help, and it is a great way to start contributing to the project. You do not need to be an expert in quantitative finance to make a difference. + +There are several ways to contribute: + +* **Reviewing**: read the existing pages (tutorials, theory pages, API reference) and report anything unclear, incorrect, or out of date. Opening an issue is valuable on its own; a PR with the fix is even better. +* **Adding context**: many pages would benefit from more background, intuition behind the models, or links to the [glossary](glossary.md) and [bibliography](bibliography.md). +* **Adding examples**: new tutorials and example scripts are always welcome. See the existing examples in `docs/examples/` and follow the structure of the pages under `docs/tutorials/`. + +To preview the documentation locally run: + +``` +uv run mkdocs serve +``` + +Example scripts can be rebuilt with `make docs-examples`. + +### Use of AI tools + +AI assisted contributions are welcome: using AI tools to draft, review, or improve documentation is perfectly fine. + +However, you are the author of your PR. You must understand every change you submit, be able to explain it, and respond to review feedback yourself. Please do not submit unreviewed AI output: if you cannot vouch for the content, do not open the PR. + +## Code of Conduct + +This project follows the [Contributor Covenant Code of Conduct](https://github.com/quantmind/quantflow/blob/main/CODE_OF_CONDUCT.md). By participating, you are expected to uphold it. From 2ca810d3b3cc81139013fd0897b8dca65d62c0b8 Mon Sep 17 00:00:00 2001 From: Luca Date: Thu, 11 Jun 2026 22:39:32 +0100 Subject: [PATCH 2/2] Add main build --- .github/workflows/build.yml | 26 +------------------------- .github/workflows/main.yml | 27 +++++++++++++++++++++++++++ 2 files changed, 28 insertions(+), 25 deletions(-) create mode 100644 .github/workflows/main.yml diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 8f8dc83..d1c0ab2 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -3,7 +3,7 @@ name: build on: push: branches-ignore: - - deploy + - main tags-ignore: - v* @@ -55,30 +55,6 @@ jobs: files: ./build/coverage.xml examples: - if: github.ref != 'refs/heads/main' uses: ./.github/workflows/examples.yml with: upload: false - - image: - if: github.ref == 'refs/heads/main' - uses: ./.github/workflows/docker-multiarch.yml - needs: build - with: - image-name: quantflow - - deploy: - name: Create Deployment - if: github.ref == 'refs/heads/main' - runs-on: ubuntu-latest - permissions: - deployments: write - needs: image - steps: - - uses: chrnorm/deployment-action@v2 - name: Create GitHub deployment - id: deployment - with: - token: "${{ secrets.TOKEN_DEPLOYMENT }}" - environment: prod - payload: '{"tag": "main-${{ github.sha }}"}' diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 0000000..23f5b6c --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,27 @@ +name: main + +on: + push: + branches: + - main + +jobs: + image: + uses: ./.github/workflows/docker-multiarch.yml + with: + image-name: quantflow + + deploy: + name: Create Deployment + runs-on: ubuntu-latest + permissions: + deployments: write + needs: image + steps: + - uses: chrnorm/deployment-action@v2 + name: Create GitHub deployment + id: deployment + with: + token: "${{ secrets.TOKEN_DEPLOYMENT }}" + environment: prod + payload: '{"tag": "main-${{ github.sha }}"}'