|
|
|
@ -4,41 +4,51 @@ To make things easier, here are a few tips: |
|
|
|
Reporting bugs, requesting features |
|
|
|
Reporting bugs, requesting features |
|
|
|
----------------------------------- |
|
|
|
----------------------------------- |
|
|
|
|
|
|
|
|
|
|
|
- Best way to report bugs and request new features is to use GitHub |
|
|
|
* Best way to report bugs and request new features is to use GitHub |
|
|
|
[issues](https://github.com/mosra/magnum/issues), but you can contact me |
|
|
|
[issues](https://github.com/mosra/magnum/issues), but you can contact me |
|
|
|
also any other way. |
|
|
|
also any other way. |
|
|
|
|
|
|
|
|
|
|
|
Code contribution |
|
|
|
Code contribution |
|
|
|
----------------- |
|
|
|
----------------- |
|
|
|
|
|
|
|
|
|
|
|
- Building and installing Magnum is described in the |
|
|
|
* Building and installing Magnum is described in the [documentation](http://mosra.cz/blog/magnum-doc/building.html). |
|
|
|
[documentation](http://mosra.cz/blog/magnum-doc/building.html). |
|
|
|
* Follow the project coding guidelines. In short -- try to match style of the |
|
|
|
- Follow the project coding guidelines. In short - try to match style of |
|
|
|
surrounding code and avoid any trailing whitespace. When in doubt, consult |
|
|
|
surrounding code and avoid any trailing whitespace. When in doubt, consult |
|
|
|
coding guidelines, which are available also [online](http://mosra.cz/blog/magnum-doc/coding-style.html). |
|
|
|
coding guidelines, which are available also |
|
|
|
* Document your code. When updating or adding new API, make sure that Doxygen |
|
|
|
[online](http://mosra.cz/blog/magnum-doc/coding-style.html). |
|
|
|
documentation is up to date. Run |
|
|
|
- Document your code. When updating or adding new API, make sure that Doxygen |
|
|
|
|
|
|
|
documentation is up to date. Run |
|
|
|
doxygen |
|
|
|
|
|
|
|
|
|
|
|
doxygen |
|
|
|
in project root to generate the documentation and check that your |
|
|
|
|
|
|
|
modifications didn't add any warnings. |
|
|
|
in project root to generate the documentation and check that your |
|
|
|
* Build unit tests (`-DBUILD_TESTS=ON` parameter to CMake) and run them |
|
|
|
modifications didn't add any warnings. |
|
|
|
using |
|
|
|
- Build unit tests (`-DBUILD_TESTS=ON` parameter to CMake) and run them |
|
|
|
|
|
|
|
using |
|
|
|
ctest --output-on-failure |
|
|
|
|
|
|
|
|
|
|
|
ctest --output-on-failure |
|
|
|
in build directory. All tests should *always* pass. Add new tests or modify |
|
|
|
|
|
|
|
the existing to make sure new code is properly covered (if possible). Here |
|
|
|
in build directory. All tests should always pass. Add new tests or modify |
|
|
|
is a [short tutorial](http://mosra.cz/blog/corrade-doc/unit-testing.html) |
|
|
|
the existing to make sure new code is properly covered (if possible). Here |
|
|
|
to help you with creating unit tests. |
|
|
|
is a [short tutorial](http://mosra.cz/blog/corrade-doc/unit-testing.html) to |
|
|
|
* Best way to contribute is by using GitHub [pull requests](https://github.com/mosra/magnum/pulls) |
|
|
|
help you with creating unit tests. |
|
|
|
-- fork the repository and make pull request from feature branch. You can |
|
|
|
- Best way to contribute is by using GitHub |
|
|
|
also send patches via e-mail or contact me any other way. |
|
|
|
[pull requests](https://github.com/mosra/magnum/pulls) - fork the repository |
|
|
|
* All your code will be released under license of the project (see [COPYING](COPYING) |
|
|
|
and make pull request from feature branch. You can also send patches via |
|
|
|
file for details), so make sure you and your collaborators (or employers) |
|
|
|
e-mail or contact me any other way. |
|
|
|
have no problems with it. If you create new files, don't forget to add |
|
|
|
- All your code will be released under license of the project, so make sure |
|
|
|
license header (verbatim copied from other files) and don't forget to add |
|
|
|
you (or your employers) have no problems with it. |
|
|
|
yourself to license header of files you added or significantly modified, |
|
|
|
|
|
|
|
for example: |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/* |
|
|
|
|
|
|
|
This file is part of Magnum. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Copyright © 2010, 2011, 2012, 2013 Vladimír Vondruš <mosra@centrum.cz> |
|
|
|
|
|
|
|
Copyright © YEAR YOUR_NAME <your@mail.com> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a |
|
|
|
|
|
|
|
... |
|
|
|
|
|
|
|
|
|
|
|
Contact |
|
|
|
Contact |
|
|
|
------- |
|
|
|
------- |
|
|
|
|