Skip to content
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.

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

Add more information about core team processes #20720

Open
wants to merge 1 commit into
base: 6.4
Choose a base branch
from
Open
Changes from all commits
Commits
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
130 changes: 117 additions & 13 deletions contributing/core_team.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,24 @@ Core Team Member Responsibilities

Core Team members are unpaid volunteers and as such, they are not expected to
dedicate any specific amount of time on Symfony. They are expected to help the
project in any way they can, from reviewing pull requests, writing documentation
to participating in discussions and helping the community in general, but their
involvement is completely voluntary and can be as much or as little as they
want.
project in any way they can. From reviewing pull requests and writing documentation,
to participating in discussions and helping the community in general. However,
their involvement is completely voluntary and can be as much or as little as
they want.

Core Team Communication
~~~~~~~~~~~~~~~~~~~~~~~

As an open source project, public discussions and documentation is favored
over private ones. All communication in the Symfony community conforms to
the :doc:`/contributing/code_of_conduct/code_of_conduct`. Request
assistance from other Core and CARE team members when getting in situations
not following the Code of Conduct.

Core Team members are invited in a private Slack channel, for quick
interactions and private processes (e.g. security issues). Each member
should feel free to ask for assistance for anything they may encounter.
Expect no judgement from other team members.

Core Organization
-----------------
Expand Down Expand Up @@ -145,6 +159,14 @@ A Symfony Core membership can be revoked for any of the following reasons:
* Willful negligence or intent to harm the Symfony project;
* Upon decision of the **Project Leader**.

Core Membership Compensation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Core Team members work on Symfony on a purely voluntary basis. In return
for their work for the Symfony project, members can get free access to
Symfony conferences. Personal vouchers for Symfony conferences are handed out
on request by the **Project Leader**.

Code Development Rules
----------------------

Expand All @@ -169,7 +191,7 @@ Pull Request Merging Policy

A pull request **can be merged** if:

* It is a :ref:`minor change <core-team_minor-changes>`;
* It is a :ref:`peripheral change <core-team_peripheral-changes>`;
* Enough time was given for peer reviews;
* It is a bug fix and at least two **Mergers Team** members voted ``+1``
(only one if the submitter is part of the Mergers team) and no Core
Expand All @@ -178,11 +200,19 @@ A pull request **can be merged** if:
``+1`` (if the submitter is part of the Mergers team, two *other* members)
and no Core member voted ``-1`` (via GitHub reviews or as comments).

.. _core-team_peripheral-changes:

.. note::

Peripheral changes comprise typos, DocBlock fixes, code standards
fixes, comment, exception message tweaks, and minor CSS, JavaScript and
HTML modifications.

Pull Request Merging Process
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

All code must be committed to the repository through pull requests, except for
:ref:`minor change <core-team_minor-changes>` which can be committed directly
:ref:`peripheral change <core-team_peripheral-changes>` which can be committed directly
to the repository.

**Mergers** must always use the command-line ``gh`` tool provided by the
Expand All @@ -205,6 +235,86 @@ following these rules:
Getting the right category is important as it is used by automated tools to
generate the CHANGELOG files when releasing new versions.

.. tip::

Core team members are part of the ``mergers`` group on the ``symfony``
Github organization. This gives them write-access to many repositories,
including the main ``symfony/symfony`` mono-repository.

To avoid unintentional pushes to the main project (which in turn creates
new versions on Packagist), Core team members are encouraged to have
two clones of the project locally:

#. A clone for their own contributions, which they use to push to their
fork on GitHub. Clear out the push URL for the main repository using
``git remote set-url --push origin dev://null``;
#. A clone for merging, which they use in combination with ``gh`` and
allows them to push to the main repository.

Upmerging Version Branches
~~~~~~~~~~~~~~~~~~~~~~~~~~

To synchronize changes in all versions, version branches are regularly
merged from oldest to latest, called 'upmerging'. This is a manual process.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
merged from oldest to latest, called 'upmerging'. This is a manual process.
merged from oldest to latest, called "upmerging". This is a manual process.

Although we talk about "single quotes" in code all the time, they are not quotes from a typography point of view.

There is no strict policy on when this occurs, but usually not more than
once a day and at least once before monthly releases.

Before starting the upmerge, Git must be configured to provide a merge
summary by running:

.. code-block:: terminal

$ git config --global merge.stat true
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would remove the --global here. It is perfectly fine to do that configuration only for the clone of the Symfony repo used for maintenance tasks in case you don't want to provide a merge summary in other repos you have on your machine


The upmerge should always be done on all maintained versions at the same
time. Refer to `the releases page`_ to find all actively maintained
versions (indicated by a green color).

The process follows these steps:

#. Start on the oldest version and make sure it's up to date with the
upstream repository;
#. Check-out the second oldest version, update from upstream and merge the
previous version from the local branch;
#. Continue this process until you reached the latest version.

.. code-block:: terminal

# 'origin' is refered to as the main upstream project
$ git fetch origin

# update the local branches
$ git checkout 6.4
$ git reset --hard origin/6.4
$ git checkout 7.2
$ git reset --hard origin/7.2
$ git checkout 7.3
$ git reset --hard origin/7.3

# upmerge 6.4 into 7.2
$ git checkout 7.2
$ git merge --no-ff 6.4
# ... resolve conflicts
$ git commit

# upmerge 7.2 into 7.3
$ git checkout 7.3
$ git merge --no-ff 7.2
# ... resolve conflicts
$ git commit

$ git push origin 7.3 7.2 6.4

.. warning::

Upmerges must be explicit, i.e. no fast-forward merges.

.. tip::

Solving merge conflicts can be challenging. You can always ping other
Core team members to help you in the process (e.g. members that merged
a specific conflicting change).

Release Policy
~~~~~~~~~~~~~~

Expand All @@ -216,13 +326,6 @@ Symfony Core Rules and Protocol Amendments
The rules described in this document may be amended at any time at the
discretion of the **Project Leader**.

.. _core-team_minor-changes:

.. note::

Minor changes comprise typos, DocBlock fixes, code standards
violations, and minor CSS, JavaScript and HTML modifications.

.. _`symfony-docs repository`: https://github.com/symfony/symfony-docs
.. _`UX repositories`: https://github.com/symfony/ux
.. _`fabpot`: https://github.com/fabpot/
Expand Down Expand Up @@ -263,3 +366,4 @@ discretion of the **Project Leader**.
.. _`mtarld`: https://github.com/mtarld/
.. _`spomky`: https://github.com/spomky/
.. _`alexandre-daubois`: https://github.com/alexandre-daubois/
.. _`the releases page`: https://symfony.com/releases