From 59698aabc4c966ce2cd3189ad200dafc902328ac Mon Sep 17 00:00:00 2001 From: fe51 <55736935+fe51@users.noreply.github.com> Date: Thu, 20 Feb 2025 16:09:42 +0100 Subject: [PATCH 1/3] docs: Added code of conduct --- CODE_OF_CONDUCT.md | 128 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 128 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..810ace7 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# 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, 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 +contact@pyronear.org. +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.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. \ No newline at end of file From d1e595f82b79c6209ed1161dde6c6344939f5a5d Mon Sep 17 00:00:00 2001 From: fe51 <55736935+fe51@users.noreply.github.com> Date: Fri, 12 Sep 2025 12:03:13 +0200 Subject: [PATCH 2/3] Added missing ex variables info --- .env.example | 5 +++++ README.md | 4 ++++ 2 files changed, 9 insertions(+) diff --git a/.env.example b/.env.example index bd1130f..362c4b3 100644 --- a/.env.example +++ b/.env.example @@ -5,3 +5,8 @@ API_PWD='dummy&P@ssw0rd!' SENTRY_DSN= DEBUG= LOGIN= + +S3_ENDPOINT_URL=your_s3_url +S3_ACCESS_KEY=your_s3_access_key +S3_SECRET_KEY=your_s3_secret_key +S3_REGION=your_s3_region diff --git a/README.md b/README.md index e6699ab..530dc2b 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,10 @@ This file will have to hold the following information: - `API_URL`: URL to the endpoint of [Pyronear Alert API](https://github.com/pyronear/pyro-api) - `API_LOGIN`: your login for the API - `API_PWD`: your password for the API +- `S3_ENDPOINT_URL`: your s3 url (S3 settings to manage occlusions masks) +- `S3_ACCESS_KEY` : your s3 access key id +- `S3_SECRET_KEY`: your s3 secret key +- `S3_REGION`: s3 region Optionally, the following information can be added: - `SENTRY_DSN`: the URL of the [Sentry](https://sentry.io/) project, which monitors back-end errors and report them back. From 10e6a2c019da77cd0b1c78582b65be200e76f711 Mon Sep 17 00:00:00 2001 From: fe51 <55736935+fe51@users.noreply.github.com> Date: Fri, 12 Sep 2025 12:03:50 +0200 Subject: [PATCH 3/3] typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 530dc2b..5af38ad 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ This file will have to hold the following information: - `API_URL`: URL to the endpoint of [Pyronear Alert API](https://github.com/pyronear/pyro-api) - `API_LOGIN`: your login for the API - `API_PWD`: your password for the API -- `S3_ENDPOINT_URL`: your s3 url (S3 settings to manage occlusions masks) +- `S3_ENDPOINT_URL`: your s3 url (S3 settings to manage occlusion masks) - `S3_ACCESS_KEY` : your s3 access key id - `S3_SECRET_KEY`: your s3 secret key - `S3_REGION`: s3 region