Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merge develop into master to create a 2.2.2 #71

Merged
merged 12 commits into from
Feb 2, 2024
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
name: Bug report
about: Create a report to help us improve this project
title: ''
labels: bug
assignees: ''

---

### Bug

#### Describe the bug
A clear and concise description of what the bug is.

#### Type of use (choose between):
- [ ] `full generation`
- [ ] `pivot generation`
- [ ] `graph generation`
- [ ] `configuration generation`

#### To Reproduce
Steps to reproduce the behavior:
1. Start a generation with configuration

#### Expected behavior
A clear and concise description of what you expected to happen.

#### Environment (please complete the following information):
- OS: [e.g. Debian]
- OS Version: [e.g. 11]
- Python version: [e.g. 3.10]
- R2GG commit: [sha]

#### Configuration:
- the configuration was inside the docker image: [eg. yes/no]
- if no, please, provide us the configuration

#### Data:
Type of data concerned by the generation : [eg. osrm, pgrouting, valhalla]
System used : [eg. official docker image of route-graph-generator, other]

#### Additional context
Add any other context about the problem here.
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

### Feature

Please, make one issue per asked feature.

#### Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

#### Describe the solution you'd like
A clear and concise description of what you want to happen.

#### Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

#### Additional context
Add any other context or screenshots about the feature request here.
21 changes: 21 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
### Need

Please, make one PR per feature or fix, and describe the reason of it.

What is appreciated is to link this PR to an existing issue created with a template of this project.

### Tasks

- [ ] Code the feature on a new branch created from develop (see next paragraph)
- [ ] Update tests
- [ ] Run tests
- [ ] Inside the docker provided by the project
- [ ] Manually if necessary
- [ ] Update the documentation
- [ ] changelog.md
- [ ] documentation directory
- [ ] If possible, rebase your branch from develop

### Code

Please, describe what has been done to achieve this feature or fix.
128 changes: 128 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -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, 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 by being friendly, patient and careful in used words
* Being welcoming, respectful of differing opinions, viewpoints, and experiences in your speech and actions
* Attempting collaboration before conflict
* 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
* Alerting community leaders if you notice a dangerous situation, someone in distress, or violations of this Code of Conduct, even if they seem inconsequential

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, pull requests, discussions 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 community spaces are issues, pull request and discussions of
the Github project.
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
[email protected] or by a report on the Github project.
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**: If possible, a private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. This warning could be public otherwise.
A public apology may be requested.
When written, impacts may be reported and moderated.

### 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](https://www.contributor-covenant.org/),
version [2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
Elements were taken from the Django Code of Conduct and the Citizen Code of Conduct.


Loading
Loading