Skip to content

Commit ae79008

Browse files
committed
Merge branch '4.0'
* 4.0: Fix build creating placeholders for missing docs Fixed a RST syntax issue in versionadded directive Fix correct extension in comment of example Fix show code without new line Fix factory-service new syntax Fix spelling of TypeScript Adding Code of Conduct
2 parents 35e30b7 + 40e2222 commit ae79008

File tree

12 files changed

+156
-15
lines changed

12 files changed

+156
-15
lines changed
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
Code of Conduct: Concrete Example Document
2+
==========================================
3+
4+
This is a living document that serves to give concrete examples of
5+
unwanted behaviour. These examples have all taken place somewhere in the
6+
PHP community in the past, and are clear code of conduct violations
7+
according to the Symfony code of conduct.
8+
9+
Concrete Examples
10+
-----------------
11+
12+
* Unwelcome comments regarding a person’s lifestyle choices and practices,
13+
including those related to food, health, parenting, drugs, and employment;
14+
* Deliberate misgendering or use of `dead names`_ (The birth name
15+
of a person who has since changed their name, often a transgender person);
16+
* Threats of violence like "The person that created this PR should be
17+
punched in the face";
18+
* Incitement of violence towards any individual, including encouraging a
19+
person to commit suicide or to engage in self-harm (even as a joke);
20+
* Sustained disruption of discussion;
21+
* Pattern of inappropriate social contact, such as requesting/assuming
22+
inappropriate levels of intimacy with others;
23+
* Continued one-on-one communication after requests to cease;
24+
* Putting down people based on their technology choices or their work.
25+
26+
The original list is inspired and modified from `geek feminism`_ and
27+
confirmed by experiences from PHPWomen.
28+
29+
.. _dead names: https://en.wiktionary.org/wiki/deadname
30+
.. _geek feminism: https://geekfeminism.org/about/code-of-conduct
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Enforcement Team
2+
================
3+
4+
We're preparing the "Enforcement Team" for the new Symfony Code of Conduct.
5+
Come back to this article in a few days to see the members of that team.
Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
Code of Conduct
2+
===============
3+
4+
Our Pledge
5+
----------
6+
7+
In the interest of fostering an open and welcoming environment, we as
8+
contributors and maintainers pledge to making participation in our project and
9+
our community a harassment-free experience for everyone, regardless of age, body
10+
size, disability, ethnic origin, gender identity and expression, level of experience,
11+
education, socio-economic status, nationality, personal appearance,
12+
religion, or sexual identity and orientation.
13+
14+
Our Standards
15+
-------------
16+
17+
Examples of behavior that contributes to creating a positive environment
18+
include:
19+
20+
* Using welcoming and inclusive language
21+
* Being respectful of differing viewpoints and experiences
22+
* Gracefully accepting constructive criticism
23+
* Focusing on what is best for the community
24+
* Showing empathy towards other community members
25+
26+
Examples of unacceptable behavior by participants include:
27+
28+
* The use of sexualized language or imagery and unwelcome sexual attention or
29+
advances
30+
* Trolling, insulting/derogatory comments, and personal or political attacks
31+
* Public or private harassment
32+
* Publishing others' private information, such as a physical or electronic
33+
address, without explicit permission
34+
* Other conduct which could reasonably be considered inappropriate in a
35+
professional setting
36+
37+
Our Responsibilities
38+
--------------------
39+
40+
:doc:`Enforcement team members </contributing/code_of_conduct/enforcement_team>`
41+
are responsible for clarifying the standards of acceptable
42+
behavior and are expected to take appropriate and fair corrective action in
43+
response to any instances of unacceptable behavior.
44+
45+
Enforcement team members have the right and responsibility to remove, edit, or
46+
reject comments, commits, code, wiki edits, issues, and other contributions
47+
that are not aligned to this Code of Conduct, or to ban temporarily or
48+
permanently any contributor for other behaviors that they deem inappropriate,
49+
threatening, offensive, or harmful.
50+
51+
Scope
52+
-----
53+
54+
This Code of Conduct applies both within project spaces and in public spaces
55+
when an individual is representing the project or its community. Examples of
56+
representing a project or community include using an official project e-mail
57+
address, posting via an official social media account, or acting as an appointed
58+
representative at an online or offline event. Representation of a project may be
59+
further defined and clarified by enforcement team members.
60+
61+
Enforcement
62+
-----------
63+
64+
Instances of abusive, harassing, or otherwise unacceptable behavior
65+
:doc:`may be reported </contributing/code_of_conduct/reporting_guidelines>`
66+
by contacting the :doc:`enforcement team members </contributing/code_of_conduct/enforcement_team>`.
67+
All complaints will be reviewed and investigated and will result in a response that
68+
is deemed necessary and appropriate to the circumstances. The enforcement team is
69+
obligated to maintain confidentiality with regard to the reporter of an incident.
70+
Further details of specific enforcement policies may be posted separately.
71+
72+
Enforcement team members who do not follow or enforce the Code of Conduct in good
73+
faith may face temporary or permanent repercussions as determined by the
74+
:doc:`core team </contributing/code/core_team>`.
75+
76+
Attribution
77+
-----------
78+
79+
This Code of Conduct is adapted from the `Contributor Covenant`_, version 1.4,
80+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
81+
82+
Related Documents
83+
-----------------
84+
85+
.. toctree::
86+
:maxdepth: 1
87+
88+
reporting_guidelines
89+
enforcement_team
90+
concrete_example_document
91+
92+
.. _Contributor Covenant: https://www.contributor-covenant.org
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Reporting Guidelines
2+
====================
3+
4+
We're preparing the "Reporting Guidelines" to explain how can you report a
5+
violation of the new Symfony Code of Conduct. Come back to this article in a
6+
few days to see the process in detail.
Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,14 @@
11
Translations
22
============
33

4-
The official Symfony documentation is published only in English, but some
5-
community groups maintain `unofficial translations`_.
4+
The official Symfony documentation is published only in English. You can
5+
read about the reasons in `this blog post`_.
66

7-
.. _`unofficial translations`: https://symfony.com/blog/discontinuing-the-symfony-community-translations
7+
We have taken steps to improve the experience when using
8+
`Google Translate`_ to prevent code blocks from being translated.
9+
10+
To translate any page in our documentation please copy any URL from the
11+
documentation and paste it into the form on the Google Translate site.
12+
13+
.. _`this blog post`: https://symfony.com/blog/discontinuing-the-symfony-community-translations
14+
.. _`Google Translate`: https://translate.google.com

contributing/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ Contributing
44
.. toctree::
55
:hidden:
66

7+
code_of_conduct/index
78
code/index
89
documentation/index
910
community/index

controller/upload_file.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ to :doc:`customize form rendering </form/form_customization>`):
9898

9999
.. code-block:: html+php
100100

101-
<!-- templates/product/new.html.twig -->
101+
<!-- templates/product/new.html.php -->
102102
<h1>Adding a new product</h1>
103103

104104
<?php echo $view['form']->start($form) ?>

doctrine.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ need. The command will ask you some questions - answer them like done below:
109109
>
110110
(press enter again to finish)
111111
112-
.. versionadded::
112+
.. versionadded:: 1.3
113113
The interactive behavior of the ``make:entity`` command was introduced
114114
in MakerBundle 1.3.
115115

frontend.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Optimizing
5151
..........
5252

5353
* :doc:`Versioning (and the manifest.json file) </frontend/encore/versioning>`
54-
* :doc:`Using A CDN </frontend/encore/cdn>`
54+
* :doc:`Using a CDN </frontend/encore/cdn>`
5555
* :doc:`Creating a "Shared" entry for re-used modules </frontend/encore/shared-entry>`
5656
* :doc:`/frontend/encore/url-loader`
5757

frontend/encore/versus-assetic.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ So what are the differences between Assetic and Encore?
4545
images.
4646
4747
.. [2] Assetic has outdated support for React.js only. Encore ships with modern
48-
support for React.js, Vue.js, Typescript, etc.
48+
support for React.js, Vue.js, TypeScript, etc.
4949
5050
Should I Upgrade from Assetic to Encore
5151
---------------------------------------

service_container/factories.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ Configuration of the service container then looks like this:
105105
106106
App\Email\NewsletterManager:
107107
# call a method on the specified factory service
108-
factory: 'App\Email\NewsletterManagerFactory:createNewsletterManager'
108+
factory: 'App\Email\NewsletterManagerFactory::createNewsletterManager'
109109
110110
.. code-block:: xml
111111
@@ -154,7 +154,7 @@ Configuration of the service container then looks like this:
154154
# config/services.yaml
155155
App\Email\NewsletterManager:
156156
# new syntax
157-
factory: 'App\Email\NewsletterManagerFactory:createNewsletterManager'
157+
factory: 'App\Email\NewsletterManagerFactory::createNewsletterManager'
158158
# old syntax
159159
factory: ['@App\Email\NewsletterManagerFactory', createNewsletterManager]
160160

setup/flex.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -74,12 +74,12 @@ SwiftmailerBundle:
7474
}
7575
7676
The ``aliases`` option allows Flex to install packages using short and easy to
77-
remember names (``composer require mailer`` vs ``composer require
78-
symfony/swiftmailer-bundle``). The ``bundles`` option tells Flex in which
79-
environments this bundle should be enabled automatically (``all`` in this
80-
case). The ``env`` option makes Flex to add new environment variables to the
81-
application. Finally, the ``copy-from-recipe`` option allows the recipe to copy
82-
files and directories into your application.
77+
remember names (``composer require mailer`` vs
78+
``composer require symfony/swiftmailer-bundle``). The ``bundles`` option tells
79+
Flex in which environments this bundle should be enabled automatically (``all``
80+
in this case). The ``env`` option makes Flex to add new environment variables to
81+
the application. Finally, the ``copy-from-recipe`` option allows the recipe to
82+
copy files and directories into your application.
8383

8484
The instructions defined in this ``manifest.json`` file are also used by
8585
Symfony Flex when uninstalling dependencies (e.g. ``composer remove mailer``)

0 commit comments

Comments
 (0)