-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
readme: add contributing file + fix outdated links
Signed-off-by: Ethan Perruzza <ethan.perruzza@gmail.com>
- Loading branch information
1 parent
8ba0d1a
commit c6306da
Showing
2 changed files
with
41 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# Contributing to OSRD | ||
|
||
All contributions, bug reports, bug fixes, documentation improvements, | ||
enhancements, and ideas are welcome. | ||
|
||
Check out our community's [Code of Conduct](https://github.com/OpenRailAssociation/osrd/blob/dev/CODE_OF_CONDUCT.md) | ||
and feel free to say hi on our [#public-general:osrd.fr](https://matrix.to/#/#public-general:osrd.fr) | ||
matrix channel 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. | ||
|
||
## Getting oriented | ||
|
||
The OSRD project has 2 primary repos: | ||
|
||
1. [`osrd`](https://github.com/OpenRailAssociation/osrd): This is where the | ||
simulator is developed. | ||
2. [`osrd-website`](https://github.com/OpenRailAssociation/osrd-website): Where | ||
the [`official website`](https://osrd.fr), blog, documentation, ... are hosted. | ||
|
||
This is the website repo. For more info on the project or to contribute to the | ||
project itself checkout the [Contributing](https://github.com/OpenRailAssociation/osrd/blob/dev/CONTRIBUTING.md) | ||
file of the main repo. | ||
|
||
## Contribute code | ||
|
||
To comply with the [DCO](http://developercertificate.org/), all commits must | ||
include a Signed-off-by line. You can find more information about this here: | ||
[osrd.fr/docs/guides/contribute/contribute-code/commit-style/#the-developer-certificate-of-origin](https://osrd.fr/en/docs/guides/contribute/contribute-code/commit-style/#the-developer-certificate-of-origin) | ||
|
||
### Pull request / code review | ||
|
||
[osrd.fr/docs/contribute/code/#share-your-changes](https://osrd.fr/en/docs/guides/contribute/code/#share-your-changes). | ||
|
||
### Report and solve bugs | ||
|
||
[osrd.fr/docs/contribute/bug-reports](https://osrd.fr/en/docs/guides/contribute/bug-reports) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters