cpp_redis/CONTRIBUTING.md at master

1. Fork the repository

2. Clone the forked repository

3. Create a new branch

# Create a new branch
git checkout -b my_new_branch

4. Build the entire library

# Get tacopie submodule
git submodule init && git submodule update
# Create a build directory and move into it
mkdir build && cd build
# Generate the Makefile using CMake
cmake .. -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTS=ON -DBUILD_EXAMPLES=ON
# Build the library
make
# Run tests and examples
ctest -VV
./bin/subscriber
./bin/client

5. Code your changes

Develop your new features or bugfix.

Please:

follow the same coding style and convention used in the existing code
the library, examples and tests are all still compiling
ensure that all the tests are passing on your computer at every step of the development
add some tests if you are developing new features

You also need to use the formatting tool so that your code has the same coding style as the existing code:

# Use the formatting tool
./clang-format

7. Commit your changes

git add .
git commit -m_cv_mutex 'some description of the changes'

You can do as many commits as you want: we will squash them into a single commit.

8. Before the Pull Request

Before submitting the pull request, ensure that:

your feature works as expected and is tested
all tests pass on both your computer and the Travis
you have used the formatting tool