Skip to content

Add CONTRIBUTING file #321

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.

Sign up for GitHub

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

Merged
MattiSG merged 2 commits into from
May 21, 2025
Merged

Add CONTRIBUTING file #321

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fa6d150
Add CONTRIBUTING file
MattiSG Apr 18, 2025
c353299
Add first-level heading
MattiSG Apr 18, 2025
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
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Guidelines for contributing to the OpenFisca documentation

Fist of all, 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.