2022-06-15 07:51:47 +00:00
|
|
|
---
|
2022-10-02 03:32:16 +00:00
|
|
|
title: "Pull Request"
|
2022-06-15 07:51:47 +00:00
|
|
|
description: "Authelia Development Pull Request Guidelines"
|
|
|
|
|
lead: "This section covers the pull request guidelines."
|
2022-06-28 05:27:14 +00:00
|
|
|
date: 2022-06-15T17:51:47+10:00
|
2022-06-15 07:51:47 +00:00
|
|
|
draft: false
|
|
|
|
|
images: []
|
|
|
|
|
menu:
|
|
|
|
|
contributing:
|
2022-10-02 03:32:16 +00:00
|
|
|
parent: "guidelines"
|
|
|
|
|
weight: 320
|
2022-06-15 07:51:47 +00:00
|
|
|
toc: true
|
2022-10-02 03:32:16 +00:00
|
|
|
aliases:
|
2022-10-20 03:21:45 +00:00
|
|
|
- /contributing/development/guidelines-pull-request/
|
2022-06-15 07:51:47 +00:00
|
|
|
---
|
|
|
|
|
|
|
|
|
|
[Pull Request] guidelines are in place in order to maintain consistency and clearly communicate our process for
|
|
|
|
|
processing merges into the [master] branch.
|
|
|
|
|
|
|
|
|
|
## Overview
|
|
|
|
|
|
|
|
|
|
* Ensure the `Allow edits by maintainers` checkbox is checked due to our [Squash Merge](#squash-merge) policy
|
|
|
|
|
* Ensure you avoid a force push due to our [Squash Merge](#squash-merge) policy and [Review](#review) complications
|
|
|
|
|
|
|
|
|
|
## Squash Merge
|
|
|
|
|
|
|
|
|
|
Every [Pull Request] will be squash merged into [master]. This requires the [Pull Request] branch to be up-to-date with
|
|
|
|
|
the [master] branch.
|
|
|
|
|
|
|
|
|
|
## Review
|
|
|
|
|
|
|
|
|
|
Every [Pull Request] will undergo a formal review process. This process is heavily complicated if you rewrite history
|
|
|
|
|
and/or perform a force push, especially after a maintainer has started a review. As such we request that any action that
|
2023-03-20 04:03:52 +00:00
|
|
|
you merge `origin/master` into your branch to synchronize your commit after the initial review and any other action that
|
|
|
|
|
rewrites history.
|
|
|
|
|
|
|
|
|
|
### Requirements
|
|
|
|
|
|
|
|
|
|
The following requirements must be met for a pull request to be accepted. This list also acts as a checklist for
|
|
|
|
|
maintainers in their review process.
|
|
|
|
|
|
|
|
|
|
- The changes must be [documented](../prologue/documentation-contributions.md) if they add or change behaviour
|
|
|
|
|
- The changes must meet the following guidelines:
|
|
|
|
|
- [General](introduction.md#general-guidelines)
|
|
|
|
|
- [Commit Message](commit-message.md)
|
|
|
|
|
- [Database Schema](database-schema.md)
|
|
|
|
|
- [Documentation](documentation.md)
|
|
|
|
|
- [Testing](testing.md)
|
|
|
|
|
- [Accessibility](accessibiliy.md)
|
|
|
|
|
- [Style](style.md)
|
|
|
|
|
- The changes adhere to all of the relevant linting and quality testing automations
|
|
|
|
|
- The pull request closes related issues by mentioning them appropriately
|
|
|
|
|
- The contribution adhere to the security by design principles by:
|
|
|
|
|
- Setting secure defaults
|
|
|
|
|
- Disallows critically insecure settings
|
|
|
|
|
- Requires explicit awareness by users that specific settings may reduce security
|
|
|
|
|
- Potential future items:
|
|
|
|
|
- Contribution includes DCO
|
|
|
|
|
- Contribution includes REUSE-compliance requirements
|
|
|
|
|
|
|
|
|
|
[Pull Request]: https://github.com/authelia/authelia/pulls
|
|
|
|
|
[master]: https://github.com/authelia/authelia/tree/master/
|
