leonetienne/Hazelnupp
1
0
Fork 0
Code Issues 3 Pull Requests Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Leonetienne 2022-04-28 12:24:34 +02:00
parent 94d79b9a0d
commit 3519d3191e
No known key found for this signature in database
GPG Key ID: C33879CD92E9708C
1 changed files with 3 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
readme.md
View File

@ -391,16 +391,14 @@ Feel free to submit a PR if you think you improved it in any way :)
## Contributing
If you want to contribute, feel free to fork the repository, and submit a pull request.
Bugfixes and tests are almost certain to be accepted, features should be agreed upon and come with tests.
Just create an issue with the tag `feature request`. Don't forget to update the UML (`Hazelnupp.vpp`)! The (free) modelling software used is [Visual Paradigm](https://www.visual-paradigm.com).
Any code added must match the existing style!
Just create an issue with the tag `feature request`.Any code added should match the existing style:
* Objects begin with a lowercase initial
* Classifiers and Functions/Methods begin with an uppercase initial
* Classifiers are camel-case
* Classifiers get documented via `/** */` for doxygen. See existing classifiers
* Members (methods and objects) get documented via `//!` for doxygen. See existing definitions
* `{` always gets a new line
* Enumerations (and their values) and macros are all-upper case snake-case
* Enumerations (and their values) and macros are all-upper.case snake-case
* No `using namespace std`
* Do `using namespace Hazelnp` in cpp files. Don't do `Hazelnp::` if possible
* Files outside the project (like STL) have to be included with `#include <>`. Not `""`