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

Fix codeowners and readme #4354

Merged
merged 3 commits into from
Jun 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,22 @@
/.github @flomonster @multun

# --- FRONT ---
/front @DGEXSolutions/front-maintainers
/front @osrd-project/front-maintainers
/front/src/common/api/osrdEditoastApi.ts
/front/src/common/api/osrdMiddlewareApi.ts

# --- EDITOAST ---
/editoast @DGEXSolutions/editoast-maintainers
/editoast @osrd-project/editoast-maintainers
/editoast/openapi.yaml
/chartos @DGEXSolutions/editoast-maintainers
/python @DGEXSolutions/editoast-maintainers
/chartos @osrd-project/editoast-maintainers
/python @osrd-project/editoast-maintainers

# --- INTEGRATION TESTS ---
/tests @eckter

# --- CORE ---
/core @DGEXSolutions/core-maintainers
/core @osrd-project/core-maintainers

# --- CORE PHYSICS ---
*Physics*.java @DGEXSolutions/physics
*Integration*.java @DGEXSolutions/physics
*Physics*.java @osrd-project/physics
*Integration*.java @osrd-project/physics
18 changes: 9 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,25 @@

All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome.

Check out our community's [Code of Conduct](https://github.com/DGEXSolutions/osrd/blob/dev/CODE_OF_CONDUCT.md) and feel free to say hi on [libera chat](https://web.libera.chat/#osrd) if you'd like. It's a nice place to chat about OSRD development, ask questions, and get to know the other contributors and users in a less formal setting. If you are not sure about what to do have a look at currently open [good first issues](https://github.com/DGEXSolutions/osrd/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22).
Check out our community's [Code of Conduct](https://github.com/osrd-project/osrd/blob/dev/CODE_OF_CONDUCT.md) and feel free to say hi on [libera chat](https://web.libera.chat/#osrd) if you'd like. It's a nice place to chat about OSRD development, ask questions, and get to know the other contributors and users in a less formal setting. If you are not sure about what to do have a look at currently open [good first issues](https://github.com/osrd-project/osrd/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22).

## Getting oriented

The OSRD project has 2 primary repos:

1. [`osrd`](https://github.com/DGEXSolutions/osrd): This is where the simulator is developed.
2. [`osrd-website`](https://github.com/DGEXSolutions/osrd-website): Where the [`official website`](https://osrd.fr), blog, documentation, ... are hosted.
1. [`osrd`](https://github.com/osrd-project/osrd): This is where the simulator is developed.
2. [`osrd-website`](https://github.com/osrd-project/osrd-website): Where the [`official website`](https://osrd.fr), blog, documentation, ... are hosted.

The `osrd` repo itself contains many smaller packages.

Some packages of interest (more details in packages' `README.md`):

- [`core`](https://github.com/DGEXSolutions/osrd/tree/dev/core): The core engine of the simulation where physics, pathfinding and conflict detection are computed.
- [`editoast`](https://github.com/DGEXSolutions/osrd/tree/dev/editoast): Service to retrieve data from the databases and make data available through http endpoints.
- [`core`](https://github.com/osrd-project/osrd/tree/dev/core): The core engine of the simulation where physics, pathfinding and conflict detection are computed.
- [`editoast`](https://github.com/osrd-project/osrd/tree/dev/editoast): Service to retrieve data from the databases and make data available through http endpoints.
It is also the place where edition of the infrastructure is computed.
- [`front`](https://github.com/DGEXSolutions/osrd/tree/dev/front): GUI of OSRD.
- [`tests`](https://github.com/DGEXSolutions/osrd/tree/dev/tests): Package to run integration tests on services.
- [`python/osrd_schemas`](https://github.com/DGEXSolutions/osrd/tree/dev/python/osrd_schemas): Definition of the railjson format.
- [`front`](https://github.com/osrd-project/osrd/tree/dev/front): GUI of OSRD.
- [`tests`](https://github.com/osrd-project/osrd/tree/dev/tests): Package to run integration tests on services.
- [`python/osrd_schemas`](https://github.com/osrd-project/osrd/tree/dev/python/osrd_schemas): Definition of the railjson format.

## What we are trying to build

Expand All @@ -42,7 +42,7 @@ OSRD also currently has the following "development process" goals:
- **Civil discourse**: We need to collectively discuss ideas and the best ideas should win.
But conversations need to remain respectful at all times.
Remember that we're all in this together.
Always follow our [Code of Conduct](https://github.com/DGEXSolutions/osrd/blob/dev/CODE_OF_CONDUCT.md).
Always follow our [Code of Conduct](https://github.com/osrd-project/osrd/blob/dev/CODE_OF_CONDUCT.md).
- **Test what you need to**: Write useful tests.
Don't write tests that aren't useful.
We generally aren't strict about unit testing every line of code.
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
</p>

<p align="center">
<a href="https://osrd.fr/en/docs/guides/contribute/"><img src="https://img.shields.io/github/contributors-anon/DGEXSolutions/osrd" alt="Contributors badge" /></a>
<a href="https://github.com/DGEXSolutions/osrd/blob/dev/LICENSE"><img src="https://img.shields.io/badge/license-LGPL-blue.svg" alt="LGPL License badge" /></a>
<a href="https://github.com/DGEXSolutions/osrd/actions/workflows/integration_tests.yml"><img src="https://github.com/DGEXSolutions/osrd/actions/workflows/integration_tests.yml/badge.svg" alt="Integration Status" /></a>
<a href="https://osrd.fr/en/docs/guides/contribute/"><img src="https://img.shields.io/github/contributors-anon/osrd-project/osrd" alt="Contributors badge" /></a>
<a href="https://github.com/osrd-project/osrd/blob/dev/LICENSE"><img src="https://img.shields.io/badge/license-LGPL-blue.svg" alt="LGPL License badge" /></a>
<a href="https://github.com/osrd-project/osrd/actions/workflows/integration_tests.yml"><img src="https://github.com/osrd-project/osrd/actions/workflows/integration_tests.yml/badge.svg" alt="Integration Status" /></a>
</p>

## What is OSRD?
Expand Down
6 changes: 3 additions & 3 deletions core/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# OSRD's Simulation backend

[![Core](https://github.com/DGEXSolutions/osrd/actions/workflows/core.yml/badge.svg)](https://github.com/DGEXSolutions/osrd/actions/workflows/core.yml)
[![Codecov](https://codecov.io/gh/DGEXSolutions/osrd/branch/dev/graph/badge.svg?token=O3NAHQ01NO&flag=core)](https://codecov.io/gh/DGEXSolutions/osrd)
[![Core](https://github.com/osrd-project/osrd/actions/workflows/core.yml/badge.svg)](https://github.com/osrd-project/osrd/actions/workflows/core.yml)
[![Codecov](https://codecov.io/gh/osrd-project/osrd/branch/dev/graph/badge.svg?token=O3NAHQ01NO&flag=core)](https://codecov.io/gh/osrd-project/osrd)

## Design Goals

Expand Down Expand Up @@ -69,4 +69,4 @@ gradlew.bat processTestResources shadowJar
# in ./build/generated_examples/small_infra for an example of the formats used.
java -jar build/libs/osrd-all.jar standalone-simulation --infra_path example/infra.json \
--sim_path example/simulation.json --res_path example/results.json
```
```
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ public void testAllowanceRangeEdgeCaseLargeTimeStep() {
applyAllowanceIgnoringUserError(allowance, maxEffortEnvelope, testContext);
}

/** Regression test: reproduces <a href="https://github.com/DGEXSolutions/osrd/issues/3199">this bug</a>.
/** Regression test: reproduces <a href="https://github.com/osrd-project/osrd/issues/3199">this bug</a>.
* This is an extreme corner case.
* The last section computed is the section between the stop at 300m and the transition at 301.
* Because it's after a stop, the speed is very low.
Expand Down Expand Up @@ -333,4 +333,4 @@ private void applyAllowanceIgnoringUserError(Allowance allowance, Envelope envel
assertEquals(OSRDError.ErrorCause.USER, e.cause);
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ public interface SignalState {

/** Returns the string representing the signal aspect.
*
* @see <a href="https://github.com/DGEXSolutions/osrd/blob/dev/front/src/common/Map/Consts/SignalsNames.ts">
* @see <a href="https://github.com/osrd-project/osrd/blob/dev/front/src/common/Map/Consts/SignalsNames.ts">
* signal names
* </a>
*/
Expand Down
4 changes: 2 additions & 2 deletions editoast/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Editoast

[![Test Editoast](https://github.com/DGEXSolutions/osrd/actions/workflows/editoast.yml/badge.svg)](https://github.com/DGEXSolutions/osrd/actions/workflows/editoast.yml)
[![Codecov](https://codecov.io/gh/DGEXSolutions/osrd/branch/dev/graph/badge.svg?token=O3NAHQ01NO&flag=editoast)](https://codecov.io/gh/DGEXSolutions/osrd)
[![Test Editoast](https://github.com/osrd-project/osrd/actions/workflows/editoast.yml/badge.svg)](https://github.com/osrd-project/osrd/actions/workflows/editoast.yml)
[![Codecov](https://codecov.io/gh/osrd-project/osrd/branch/dev/graph/badge.svg?token=O3NAHQ01NO&flag=editoast)](https://codecov.io/gh/osrd-project/osrd)

This service allow to edit an infrastructure using railjson schema.
It will apply modification and update generated data such as object geometry.
Expand Down
2 changes: 1 addition & 1 deletion front/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# OSRD's Front

[![Front](https://github.com/DGEXSolutions/osrd/actions/workflows/front.yml/badge.svg)](https://github.com/DGEXSolutions/osrd/actions/workflows/front.yml)
[![Front](https://github.com/osrd-project/osrd/actions/workflows/front.yml/badge.svg)](https://github.com/osrd-project/osrd/actions/workflows/front.yml)

## How to launch project for developpement purpose ?

Expand Down
2 changes: 1 addition & 1 deletion python/api/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# OSRD's API

[![API](https://github.com/DGEXSolutions/osrd/actions/workflows/api.yml/badge.svg)](https://github.com/DGEXSolutions/osrd/actions/workflows/api.yml)
[![API](https://github.com/osrd-project/osrd/actions/workflows/api.yml/badge.svg)](https://github.com/osrd-project/osrd/actions/workflows/api.yml)

This service handle OSRD models and schema using [Django](https://www.djangoproject.com/).
Multiple extension are used such as:
Expand Down