-
-
Notifications
You must be signed in to change notification settings - Fork 64
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
- Our build system is makefile (on Linux) & Visual Studio project files (on Windows). We don't use cross-platform building tools like CMake because I think it only makes things more complicated. Just maintaining two native build systems (makefile and Visual Studio) is easier and more friendly to users. Casbin is a library instead of app, so I must choose something used more widely. Please make your code compile well on both platforms before any PR. I personally will test the code on Visual Studio and CLion on Windows.
- We use Google test as the test framework.
3. Useuse namespace std;, there should be nostd::stringin the code. [Abandoned] - The allowed source file name's extensions are
.cppand.h. Others like.cc,.hppare forbidden. - Write minimized working code first, like file adapter, model, enforcer. Don't try to setup a code framework, or something like CI, linter only. I cannot witness those things work well without concrete code.
- Use
printfinstead ofcout. Nocoutwill be allowed in the code. - Follow the module (filename) naming of Golang Casbin: https://github.com/casbin/casbin . Do not invent a name by yourself.
- Your code in PR should compile well itself on Windows and Linux, better with tests. Do not leave a feature in half, which has 100+ compile errors and then send PR.
- Base your code on our latest master branch, follow our folder structure, filename naming, etc.
- Do not use CMake or any cross-platform building tools (I have to say it again).
- Don't commit so many code in one PR. One PR can only contain one commit, with 100 LoC change.
- Other things please follow Google C++ Style Guide: https://google.github.io/styleguide/cppguide.html
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation