forked from filoper/ms-client
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
40 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
## Proposed changes | ||
* | ||
* | ||
* | ||
|
||
### Pull Request Readiness Checklist | ||
|
||
- [ ] The PR is proposed to proper branch | ||
- [ ] If applicable, there is reference to original bug report and related work | ||
- [ ] Code is formatted |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# Contributing to ms-client | ||
|
||
### DOs | ||
|
||
* **DO** create one pull request per improvement. | ||
* **DO** follow the [Coding and Style](#code-formatting) guidelines, and keep code changes as small as possible. | ||
* **DO** link the issue you are addressing in the pull request. | ||
* **DO** write a good description for your pull request. More detail is better. | ||
|
||
### DO NOTs | ||
|
||
* **DO NOT** merge multiple changes into one PR unless they have the same root cause. | ||
* **DO NOT** merge directly into the master branch. | ||
|
||
## Code Formatting | ||
|
||
***Run clang-format*** | ||
|
||
Use the following commands from the project's root directory to run clang-format (must be installed on the host system). | ||
|
||
**Run the CMake target for `clang-format`:** | ||
````bash | ||
cmake --build build --target clang-format | ||
```` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters