Skip to content

Commit 8c5f9f8

Browse files
authored
Drop alphabetical ordering of methods (#2984)
related: #2955
1 parent 8befce8 commit 8c5f9f8

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,16 +30,16 @@ We follow _Rob Pike's 5 Rules of Programming_:
3030
> * **Rule 4. Fancy algorithms are buggier than simple ones, and they're much harder to implement.** Use simple algorithms as well as simple data structures.
3131
> * **Rule 5. Data dominates.** If you've chosen the right data structures and organized things well, the algorithms will almost always be self-evident. Data structures, not algorithms, are central to programming.
3232
>
33-
> Pike's rules 1 and 2 restate Tony Hoare's famous maxim "Premature optimization is the root of all evil." Ken Thompson rephrased Pike's rules 3 and 4 as "When in doubt, use brute force.". Rules 3 and 4 are instances of the design philosophy KISS. Rule 5 was previously stated by Fred Brooks in The Mythical Man-Month. Rule 5 is often shortened to "write stupid code that uses smart objects".
33+
> Pike's rules 1 and 2 restate Tony Hoare's famous maxim, "Premature optimization is the root of all evil." Ken Thompson rephrased Pike's rules 3 and 4 as "When in doubt, use brute force.". Rules 3 and 4 are instances of the design philosophy KISS. Rule 5 was previously stated by Fred Brooks in The Mythical Man-Month. Rule 5 is often shortened to "write stupid code that uses smart objects".
3434
3535
_Source: http://users.ece.utexas.edu/~adnan/pike.html_
3636

3737
### Javadoc
3838

39-
* Public API needs javadoc, e.g. public classes and public methods.
40-
* Non-trivial private methods need javadoc, too.
39+
* Public API needs Javadoc, e.g., public classes and public methods.
40+
* Non-trivial private methods need Javadoc, too.
4141
* A package, which is part of the public API, contains a `package-info.java`.
42-
* Unit tests contain no javadoc at all (because they introduce no new API and contain no business logic).
42+
* Unit tests contain no Javadoc at all (because they introduce no new API and contain no business logic).
4343
* Running `mvn javadoc:javadoc` results in no javadoc errors.
4444
* All classes start with the following copyright notice in order to apply the Apache-2.0 license:
4545

@@ -71,7 +71,7 @@ _Source: http://users.ece.utexas.edu/~adnan/pike.html_
7171
* Package names are denoted in the singular.
7272
* Packages are sliced by domain (no util or tool packages).
7373
* Package private classes are used in order to hide non-public API.
74-
* Inner classes are preferred over package private classes in case of one-to-one dependencies.
74+
* Inner classes are preferred over package-private classes in case of one-to-one dependencies.
7575

7676
### File structure
7777

@@ -82,7 +82,6 @@ We organize our classes and interfaces in the following way:
8282
1. static API
8383
2. non-static API
8484
3. adjusted return types
85-
* The methods of each of these sections are alphabetically ordered.
8685

8786
```java
8887
/**

0 commit comments

Comments
 (0)