Please report all bugs, issues, comments and feature requests into our issues.
We welcome all Pull Requests, just send the code and we will help you improve it. You can read the Style Guide and Design that your code should follow, but do not worry if you miss anything, we will let you know in the review.
The code formatting of each PR is checked by the CI using clang-format.
If changes are required, a comment will be added to the PR with instructions for fixing the formatting.
You can also do this formatting locally (if you have clang-format installed) by running ./bin/test_format_local.sh
It is preferable to use the same version of clang-format as the CI does (currently version 11), as different versions can give different results.
- MacOS
brew install clang-format- https://formulae.brew.sh/formula/clang-format
- Debian/Ubuntu:
sudo apt install clang-format-11- see https://apt.llvm.org/ if not available in your version of Debian/Ubuntu
- Conda:
To add a git hook that formats the code locally on every commit, you can run this command from the root of the symengine repo:
ln $(pwd)/bin/test_format_local.sh .git/hooks/pre-commit
To remove the hook, remove the .git/hooks/pre-commit file.