Skip to content

Commit 2ca45d4

Browse files
authored
Add code formatting instructions to CONTRIBUTING.md (#1343)
Also merged testing into main steps
1 parent bfc53ca commit 2ca45d4

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

.github/CONTRIBUTING.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
#### Contributing
22
If you would like to contribute to hazelcast-cpp-client;
33
- Fork the original repo
4+
- Test your changes - the script executes builds and runs the unit tests for all bit and library versions:
5+
- Linux/Mac - [`scripts/test-unix.sh`](../scripts/test-unix.sh)
6+
- Windows - [`scripts/test-windows.bat`](../scripts/test-windows.sh)
7+
- Format the code using `clang-format`
8+
- [`scripts/format-all.sh`](../scripts/format-all.sh) can do this for you
49
- Commit your contributions in a new branch
510
- Send a Pull Request
611

712
For detailed instructions for our git process: [Developing with Git](https://hazelcast.atlassian.net/wiki/display/COM/Developing+with+Git)
813

914
In order to merge your pull request, we need the contributor to sign [Hazelcast Contributor Agreement](https://hazelcast.atlassian.net/wiki/display/COM/Hazelcast+Contributor+Agreement). You do not have to wait for approval for doing this step.
10-
11-
Please make sure that your code passes `testLinux.sh` for Linux/Mac and `testWindows.bat` for MS Windows. The script executes builds and runs the unit tests for all bit and library versions. (Alternatively, you can also use `testLinuxSingleCase.sh` or `testWindowsSingleCase.sh` for testing with a specific bit aversion and library type.

0 commit comments

Comments
 (0)