diff options
| author | Thales Lima Oliveira <thaleslima.ufu@gmail.com> | 2019-10-15 02:42:10 -0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-10-15 02:42:10 -0300 |
| commit | 9860463c2ad678a9e0963277d64ad99931446f48 (patch) | |
| tree | 87beae718cc6bb8bbab8f95b4cc7a650dae5243b | |
| parent | b922c8c37bfdf075609ee99c68f3441f5aafbd99 (diff) | |
| download | PSP.git-9860463c2ad678a9e0963277d64ad99931446f48.tar.gz PSP.git-9860463c2ad678a9e0963277d64ad99931446f48.tar.xz PSP.git-9860463c2ad678a9e0963277d64ad99931446f48.zip | |
Update contributing.md
| -rw-r--r-- | contributing.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/contributing.md b/contributing.md index fcb2746..42e9058 100644 --- a/contributing.md +++ b/contributing.md @@ -24,11 +24,17 @@ Please, follow the guidelines with the following **exceptions**: - _Physical Files Organization_: Always use the MVC pattern described in published papers; - _Use wx prefix for all public symbols_: wx prefix are not needed; - _Restrictions on C++ Features_: The are no C++ feature restrictions in PSP-UFU. + +Use the comments to create your code documentation, using the [Doxygen style](http://www.doxygen.nl/). + +The [Project Documentation](https://thales1330.github.io/PSP/doxygen/html/index.html) is your best friend! Explore it! ## Pull requests After your contribution, please send a pull request with detailed description in order to make clear the modifications and new features. Aways test your code with the samples projects before pull requests. + + Good coding! Thales |