Skip to content

Commit

Permalink
Add CONTRIBUTION_PROCESS.md
Browse files Browse the repository at this point in the history
  • Loading branch information
matks committed May 17, 2023
1 parent f7b2840 commit f7856ec
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions .github/CONTRIBUTION_PROCESS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
This repository contains the developer documentation sources.

# Reviewers

On this reposiroty we have primary reviewers and regular reviewers.

Primary reviewers are the people who mostly shape and structure this repository. Although it's not mandatory, it's highly recommended that at least one of them review and approve a Pull Request before he can be merged.

Primary reviewers are
- @kpodemski
- @thomasnares

As regular reviewers, any committer on the organization can review submitted Pull Requests.

### Examples

PR [#1631](https://github.com/PrestaShop/docs/pull/1631) was approved and merged by primary reviewer @kpodemski.

PR [#1639](https://github.com/PrestaShop/docs/pull/1639) was not approved by primary reviewers as it was a simple 3-line fix. Two committers approved it and merged it.

# Pull Request workflow

## Steps

Pull Requests can be made against different branches. One branch contains the sources for a given PrestaShop version:
- branch `1.7.x` contains the sources for PrestaShop 1.7 developer documentation
- branch `8.x` contains the sources for PrestaShop 8 developer documentation

Pull Requests only need to be reviewed by reviewers. There is no need to test, unless it introduces a complex change such as a new Hugo markdown. In this situation reviewers should checkout the branch and verify it behaves as expected.

After a Pull Request has been approved it can be merged.

## After the merge

There is no need to milestone merged Pull Requests, however if merger believes the change should be backported on other branches, he can ask kindly the author to do it and add the label 'Needs backport'.

When the Pull Request to backport the change to another branch is submitted and merged, the label 'Needs backport' should be replaced by label 'Backported'.

0 comments on commit f7856ec

Please sign in to comment.