mirrors/dmd
1
0
Fork 0
mirror of https://github.com/dlang/dmd.git synced 2025-04-26 05:00:16 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

small additions to CONTRIBUTING.md (#14975)

Browse source
This commit is contained in:
Walter Bright 2023-03-09 22:48:52 -08:00 • committed by GitHub
parent fa54dd6eee
commit 3fbdb99a48
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

18
CONTRIBUTING.md
View file

@ -166,11 +166,15 @@ accomplishes nothing. The more of its internal details can be made private, the
19. Try to use function prefixes: 19. Try to use function prefixes:
*` do` for performing some action
These functions should not be mutating the data nor issuing error messages.
Make them `const` and `pure` if practical.
* `is` is the parameter in a certain category? * `is` is the parameter in a certain category?
* `has` does the parameter have a certain feature? * `has` does the parameter have a certain feature?
* `can` for can I do X with the parameter? * `can` for can I do X with the parameter?
* `needs` for things necessary
Such functions should not be mutating the data nor issuing error messages.
20. The function return value variable should be named `result`. 20. The function return value variable should be named `result`.
@ -179,6 +183,16 @@ Such functions should not be mutating the data nor issuing error messages.
22. Public declarations in modules should be "above the fold", i.e. first in the file, thus making the API of the module 22. Public declarations in modules should be "above the fold", i.e. first in the file, thus making the API of the module
easily visible when opening the file. Private declarations should follow afterwards. easily visible when opening the file. Private declarations should follow afterwards.
23. Identifiers implying a boolean value should be framed as positives. For example,
`doUnittests` is preferred over `noUnittests`. Never want to see double negatives such
as `if (!noUnittests)`.
24. Identifier Case
* types should start with a capital letter
* variables and functions should start with a lower case letter
* module names should be all lower case (for maximal compatibility with case insensitive file systems)
## The following will not be viewed with favor: ## The following will not be viewed with favor:
1. Shuffling all the code about 1. Shuffling all the code about