CONTRIBUTING.md

Contributing

Code of Conduct

See CODE_OF_CONDUCT.md

How Can I Contribute?

Issues

Filling issues is a great and easy way to help find bugs and get new features implemented.

Bugs

If you're reporting a security issue, please email me at [email protected] (gpg key), otherwise if you're reporting a bug, please create an issue.

Feature Requests

If you have an idea for a new feature or an enhancement, please create an issue.

Pull Requests

Every PR should not break tests and ideally include tests for added functionality as well as documentation.

How to Send Pull Requests

Everyone is welcome to contribute code to yacx via GitHub pull requests (PRs).

To create a new PR, fork the project in GitHub and clone the upstream repo:

$ git clone https://github.com/zeratax/yacx.git

Add your fork as an origin:

$ git remote add fork https://github.com/YOUR_GITHUB_USERNAME/yacx.git

Build:

cmake -H. -Bbuild
make -C build

Test:

make -C build test

or

pushd build/test/bin
./tests

Check out a new branch, make modifications and push the branch to your fork:

$ git checkout -b <feature>
# edit files
$ git commit
$ git push fork <feature>

Open a pull request against the main yacx repo.

Development

C++

yacx tries to follow the CppCoreGuidlines as much as possible

Code formatting will be enforced automatically via clang-format

Tests are written using the Catch2 test-framework

Java

Tests are written using Junit