Skip to content
This repository was archived by the owner on Jan 21, 2020. It is now read-only.

Commit 182eab9

Browse files
committedNov 18, 2018
Prepare release 2.0.0-alpha.1
1 parent d81e6c6 commit 182eab9

File tree

2 files changed

+48
-47
lines changed

2 files changed

+48
-47
lines changed
 

‎CHANGELOG.md

+46-46
Original file line numberDiff line numberDiff line change
@@ -2,34 +2,34 @@
22

33
All notable changes to this project will be documented in this file, in reverse chronological order by release.
44

5-
## 2.0.0 - TBD
5+
## 2.0.0-alpha.1 - 2018-11-18
66

77
### Added
88

9-
- [#5](https://github.com/zendframework/zend-coding-standard/pull/5) adds
9+
- [#5](https://github.com/zendframework/zend-coding-standard/pull/5) adds
1010
online documentation: https://docs.zendframework.com/zend-coding-standard/
11-
- [#5](https://github.com/zendframework/zend-coding-standard/pull/5) adds
11+
- [#5](https://github.com/zendframework/zend-coding-standard/pull/5) adds
1212
PSR-12 rules.
13-
13+
1414
*NOTE:* PSR-12 is not finalized. e.g. The `!` operator and `:` placement for
15-
return values are still under discussion. We will change these rules, and,
15+
return values are still under discussion. We will change these rules, and,
1616
when PSR-12 is finalized, adapt them.
17-
- [#5](https://github.com/zendframework/zend-coding-standard/pull/5) extends
17+
- [#5](https://github.com/zendframework/zend-coding-standard/pull/5) extends
1818
PSR-12 with ZendFramework specific rules:
19-
19+
2020
*NOTE:* Most of these rules should look familiar as they are already being
21-
used in components rewritten for PHP 7.1.
22-
23-
- There should be one space on either side of an equals sign used to assign
24-
a value to a variable. In case of a block of related assignments, more
21+
used in components rewritten for PHP 7.1.
22+
23+
- There should be one space on either side of an equals sign used to assign
24+
a value to a variable. In case of a block of related assignments, more
2525
space may be inserted before the equal sign to promote readability.
26-
- Short array syntax must be used to define arrays.
27-
- All values in multiline arrays must be indented with 4 spaces.
28-
- All array values must be followed by a comma, including the last value.
29-
- Whitespace is not allowed around the opening bracket or before the
26+
- Short array syntax must be used to define arrays.
27+
- All values in multiline arrays must be indented with 4 spaces.
28+
- All array values must be followed by a comma, including the last value.
29+
- Whitespace is not allowed around the opening bracket or before the
3030
closing bracket when referencing an array.
3131
- The `global` keyword may not be used.
32-
- The `PHP_SAPI` constant must be used instead of the `php_sapi_name()`
32+
- The `PHP_SAPI` constant must be used instead of the `php_sapi_name()`
3333
function.
3434
- PHP function calls must be in lowercase.
3535
- PHP functions which are an alias may not be used.
@@ -40,22 +40,22 @@ All notable changes to this project will be documented in this file, in reverse
4040
- The words _private_, _protected_, _static_, _constructor_, _deconstructor_,
4141
_Created by_, _getter_ and _setter_, may not be used in comments.
4242
- The annotations `@api`, `@author`, `@category`, `@created`, `@package`,
43-
`@subpackage` and `@version` may not be used in comments. Git commits
43+
`@subpackage` and `@version` may not be used in comments. Git commits
4444
provide accurate information.
45-
- The asterisks in a doc comment should align, and there should be one space
45+
- The asterisks in a doc comment should align, and there should be one space
4646
between the asterisk and tag.
47-
- Comment tags `@param`, `@throws` and `@return` should not be aligned or
47+
- Comment tags `@param`, `@throws` and `@return` should not be aligned or
4848
contain multiple spaces between the tag, type and description.
49-
- If a function throws any exceptions, they should be documented in `@throws`
49+
- If a function throws any exceptions, they should be documented in `@throws`
5050
tags.
51-
- The `@var` tag may be used in inline comments to document the _Type_ of
51+
- The `@var` tag may be used in inline comments to document the _Type_ of
5252
properties.
5353
- Single-line comments with a `@var` tag should be written as one-liners.
5454
- Shorthand scalar typehint variants must be used in docblocks.
55-
- Each PHP file should have a page level docblock with `@see`, `@copyright`
56-
and `@license`. The copyright date should only be adjusted if the file has
55+
- Each PHP file should have a page level docblock with `@see`, `@copyright`
56+
and `@license`. The copyright date should only be adjusted if the file has
5757
changed.
58-
- Each PHP file should have a strict type declaration at the top after the
58+
- Each PHP file should have a strict type declaration at the top after the
5959
page level docblock.
6060
- Import statements should be alphabetically sorted.
6161
- Import statements should not be grouped.
@@ -64,57 +64,57 @@ All notable changes to this project will be documented in this file, in reverse
6464
- Unused import statements are not allowed.
6565
- Classes and function within the same namespace should not be imported.
6666
- Imports should not have an alias with the same name.
67-
- A class should not have unused private constants, (or write-only)
67+
- A class should not have unused private constants, (or write-only)
6868
properties and methods.
69-
- Class name resolution via `::class` should be used instead of
70-
`__CLASS__`, `get_class()`, `get_class($this)`, `get_called_class()` and
69+
- Class name resolution via `::class` should be used instead of
70+
`__CLASS__`, `get_class()`, `get_class($this)`, `get_called_class()` and
7171
`get_parent_class()`.
7272
- Methods may not have the final declaration in classes declared as final.
73-
- The colon used with return type declarations MUST be surrounded with 1
73+
- The colon used with return type declarations MUST be surrounded with 1
7474
space.
75-
- Nullable and optional arguments, which are marked as `= null`, must have
75+
- Nullable and optional arguments, which are marked as `= null`, must have
7676
the `?` symbol present.
77-
- Control Structures must have at least one statement inside of the body.
77+
- Control Structures must have at least one statement inside of the body.
7878
- Catch blocks may be empty.
7979
- Catch blocks must be reachable.
80-
- Catch blocks must use `Throwable` instead of `Exception`.
80+
- Catch blocks must use `Throwable` instead of `Exception`.
8181
- The not (`!`) operator must be followed by exactly one space.
8282
- The `&&` and `||` operators must be used instead of `AND` and `OR`.
8383
- The null coalescing operator `??` should be used when possible.
8484
- Assignment operators (eg `+=`, `.=`) should be used when possible.
85-
- Unused variables should not be passed to closures via `use`.
85+
- Unused variables should not be passed to closures via `use`.
8686
- The code may not contain unreachable code.
8787
- The backtick operator may not be used for execution of shell commands.
88-
- Class and Interface names should be unique in a project and must have a
88+
- Class and Interface names should be unique in a project and must have a
8989
unique fully qualified name.
9090
- Methods that only call the parent method should not be defined.
9191
- Files that contain PHP code should only have PHP code and should not have
9292
any _"inline HTML"_.
93-
- There must be exactly one space after a type cast.
93+
- There must be exactly one space after a type cast.
9494
- Constructors should be named `__construct`, not after the class.
95-
- The opening PHP tag should be the first item in the file.
96-
- Strings should not be concatenated together unless used in multiline for
97-
readability.
98-
- Loose `==` and `!=` comparison operators should not be used. Use `===`
95+
- The opening PHP tag should be the first item in the file.
96+
- Strings should not be concatenated together unless used in multiline for
97+
readability.
98+
- Loose `==` and `!=` comparison operators should not be used. Use `===`
9999
and `!==` instead.
100100
- Language constructs must be used without parentheses where possible.
101101
- Short list syntax `[...]` should be used instead of `list(...)`.
102-
- Short form of type keywords must be used. i.e. `bool` instead of
103-
`boolean`, `int` instead of `integer`, etc. The `binary` and `unset` cast
102+
- Short form of type keywords must be used. i.e. `bool` instead of
103+
`boolean`, `int` instead of `integer`, etc. The `binary` and `unset` cast
104104
operators are not allowed.
105105
- Parentheses should not be used if they can be omitted.
106106
- Semicolons `;` should not be used if they can be omitted.
107-
- Variables should be returned directly instead of assigned to a variable
107+
- Variables should be returned directly instead of assigned to a variable
108108
which is not used.
109-
- The `self` keyword should be used instead of the current class name, and
109+
- The `self` keyword should be used instead of the current class name, and
110110
should not have spaces around `::`.
111-
- Static methods should not use `$this`.
112-
- Double quote strings may only be used if they contain variables.
111+
- Static methods should not use `$this`.
112+
- Double quote strings may only be used if they contain variables.
113113
- Strings should not be enclosed in parentheses when being echoed.
114114
- Type casts should not have whitespace inside the parentheses.
115-
- The opening brace for functions should be on a new line with no blank
115+
- The opening brace for functions should be on a new line with no blank
116116
lines surrounding it.
117-
- The PHP constructs `echo`, `print`, `return`, `include`, `include_once`,
117+
- The PHP constructs `echo`, `print`, `return`, `include`, `include_once`,
118118
`require`, `require_once`, and `new`, should have one space after them.
119119
- The object operator `->` should not have any spaces around it.
120120
- Semicolons should not have spaces before them.

‎composer.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@
2525
},
2626
"extra": {
2727
"branch-alias": {
28-
"dev-master": "2.0.x-dev"
28+
"dev-master": "1.0.x-dev",
29+
"dev-develop": "2.0.x-dev"
2930
}
3031
},
3132
"autoload": {

0 commit comments

Comments
 (0)
This repository has been archived.