From fa6d1504995f5e018dea9b596c8d77ad5845a90c Mon Sep 17 00:00:00 2001 From: Matti Schneider Date: Fri, 18 Apr 2025 06:39:42 +0200 Subject: [PATCH 1/2] Add CONTRIBUTING file Fix https://github.com/openfisca/openfisca-doc/issues/275 --- CONTRIBUTING.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..5dad3e71 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,19 @@ +Thank you for wanting to contribute to OpenFisca! :smiley: + +## Copywriting + +British English is used in the documentation. + +## Pull requests + +We follow the [GitHub Flow](https://docs.github.com/get-started/using-github/github-flow): all code contributions are submitted via a pull request towards the `main` branch. + +Opening a Pull Request means you want that code to be merged. If you want to only discuss it, send a link to your branch along with your questions through whichever communication channel you prefer. + +### Peer reviews + +All pull requests must be reviewed by someone else than their original author. + +> In case of a lack of available reviewers, one may review oneself, but only after at least 24 hours have passed without working on the code to review. + +To help reviewers, make sure to add to your PR a **clear text explanation** of your changes. From c3532998a8a4b378803c79d7090b37d61013d297 Mon Sep 17 00:00:00 2001 From: Matti Schneider Date: Fri, 18 Apr 2025 06:42:49 +0200 Subject: [PATCH 2/2] Add first-level heading --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5dad3e71..d8fac99f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,6 @@ -Thank you for wanting to contribute to OpenFisca! :smiley: +# Guidelines for contributing to the OpenFisca documentation + +Fist of all, thank you for wanting to contribute to OpenFisca! :smiley: ## Copywriting