inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-07-31 17:39:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Change a note about comments in the code

Browse Source
This commit is contained in:
Alex Mukha
2017-03-08 20:49:41 +00:00
committed by GitHub
parent 241383fe0d
commit 81e821b85c
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
View File

@@ -30,7 +30,7 @@ Please, pay attention to the level of test being done. It is preferred to create
* Empty lines do not have tabs/spaces
* All new public methods have JavaDoc
* The JavaDoc should be compliant with [Java8 DocLint](http://openjdk.java.net/jeps/172)
* Comments are added only where very necessary
* If the code is not self explanatory, then comments/JavaDoc should be added as appropriate. Excessive comments should be avoided.
* The strings which are shown to the user (in the UI) should be put in localization property bundles. Our localization team will handle the translations if required.
##### Commit message