forked from microsoft/SEAL
-
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.
Edited README.md and CONTRIBUTING.md. Partially removed column width …
…limit in markdown files and inserted line breaks after each sentence. This will have a cleaner git history.
- Loading branch information
Wei Dai
committed
Apr 21, 2020
1 parent
9a3d6a1
commit a066559
Showing
2 changed files
with
173 additions
and
235 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 |
---|---|---|
@@ -1,15 +1,25 @@ | ||
# Contributing | ||
|
||
This project welcomes contributions and suggestions. Most contributions require you to agree to a | ||
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us | ||
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com. | ||
This project welcomes contributions and suggestions. | ||
Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. | ||
For details, visit https://cla.opensource.microsoft.com. | ||
|
||
When you submit a pull request, a CLA bot will automatically determine whether you need to provide | ||
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions | ||
provided by the bot. You will only need to do this once across all repos using our CLA. | ||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). | ||
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/). | ||
Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) for any additional questions or comments. | ||
|
||
**IMPORTANT:** Pull requests must be submitted to the branch called *contrib*. Pull requests to any other branch will not be accepted. | ||
### Pull Requests | ||
|
||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). | ||
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or | ||
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. | ||
Submit pull requrests to **branch *contrib***. | ||
Pull requests to any other branch will not be accepted. | ||
|
||
When you submit a pull request, a CLA bot will automatically determine whether you need to **provide a CLA** and decorate the PR appropriately (e.g., status check, comment). | ||
Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA. | ||
|
||
### Formatting | ||
|
||
Microsoft SEAL uses a customized `.clang-format` configuration for C++ code styling. | ||
A script `tools/scripts/clang-format-all.sh` is provided to easily format all C++ sources and headers in the `native` directory. | ||
|
||
Documentation are mostly written in GitHub-flavored Markdown. | ||
A line break is required after each full sentence. |
Oops, something went wrong.