ic
/
magnum
mirror of https://github.com/mosra/magnum.git
6
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1378 Commits
21 Branches
19 Tags
70 MiB
 
 
 
 
 
Tree: 1415f70a7f
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '1415f70a7f'
${ noResults }
magnum/CONTRIBUTING.md

1.9 KiB
Raw Blame History

Bug reports, feature requests or code contributions are always very welcome. To make things easier, here are a few tips:

Reporting bugs, requesting features

  • Best way to report bugs and request new features is to use GitHub issues, but you can contact me also any other way.

Code contribution

  • Building and installing Magnum is described in the documentation.

  • Follow the project coding guidelines. In short - try to match style of surrounding code and avoid any trailing whitespace. When in doubt, consult coding guidelines, which are available also online.

  • Document your code. When updating or adding new API, make sure that Doxygen documentation is up to date. Run

    doxygen

    in project root to generate the documentation and check that your modifications didn't add any warnings.

  • Build unit tests (-DBUILD_TESTS=ON parameter to CMake) and run them using

    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 is a short tutorial to help you with creating unit tests.

  • Best way to contribute is by using GitHub pull requests - fork the repository and make pull request from feature branch. You can also send patches via e-mail or contact me any other way.

  • All your code will be released under license of the project, so make sure you (or your employers) have no problems with it.

Contact