V1.0.2 (homenc#352)

- Source code contribution policy
- HElib now builds with compiler pedantic flags
- Consistent C++ format style adopted
- Improved sampling functions
- Bug fixes

Co-Authored-By: Hamish Hunt <[email protected]>
Co-Authored-By: Jack L Crawford <[email protected]>
Co-Authored-By: Enrico Steffinlongo <[email protected]>
Co-Authored-By: VICTOR J. SHOUP <[email protected]>

Author: 5 people

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected] and/or [email protected]. 
+All complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,30 @@
+# Contributing to the Homomorphic Encryption Library HElib
+
+Adding new features, improving documentation, fixing bugs, writing new 
+tests, designing and coding new examples or writing tutorials are all examples 
+of helpful contributions. 
+
+A contribution to HElib can be initiated through GitHub pull request (PR).
+HElib is written in C++14 and uses `clang-format` for the formatting of the code.
+Requiremens and installation instructions can be found in [INSTALL.md](INSTALL.md).
+When making code contributions to HElib, we ask that you follow the `C++14` 
+coding standard and format your code using the [clang format](.clang-format) 
+style file included in this distribution. Please provide unit/regression 
+tests that are relevant to your code contribution. 
+
+This project uses Developer Certificate of Origin [DCO](https://developercertificate.org/). 
+Be sure to sign off your commits using the `-s` flag or adding `Signed-off-By: Name<Email>` in the commit message.
+
+### Example commit message
+```bash
+git commit -s -m 'Informative commit message'
+```
+
+### Unit/Regression tests
+
+Whether you are contributing a new feature, updating or bug fixing the code elsewhere, you need to ensure that your HElib build passes the regression test suite. 
+
+HElib test suite uses the [Google Test Framework](https://github.com/google/googletest). Additional information on HElib's test suite can be found in [TESTS.md](TESTS.md). Please remember to provide unit/regression tests that are relevant to your code contribution.
+
+Once all the tests have passed, and you are satisfied with your contribution, open a pull request into the `master` branch from **your fork of the repository** to request adding your contributions into the main code base.
+

INSTALL.md

@@ -14,15 +14,21 @@ dependencies to be installed by you and available in the system.
 
 ## General prerequisites
 
-- cmake >= 3.10.2 (*)
 - GNU make >= 3.82
-- g++ >= 7.3.1 (for Linux environments)
-- mac OS Apple clang >= 11.0.0 (macOS environments)
 - pthreads
 - git >= 1.8.3 (required to build and run the HElib test suite)
 
-(*) On macOS, ideally use cmake 3.17.3+ as it fixes many issues on certain builds on Mojave
-onwards.
+**Linux environment:**
+- g++ >= 7.3.1
+- cmake >= 3.10.2
+
+**macOS environment:**
+- Apple clang >= 11.0.0 (available with Xcode >= 11.0)
+- Xcode Command Line Tools (can be installed with the command `xcode-select --install` in a teminal)
+- cmake >= 3.17.3 (available from [CMake](https://cmake.org/) or [MacPorts Project](https://www.macports.org/) and [Homebrew](https://brew.sh/) as packages)
+
+**For development:**
+- clang-format >= 9.0.0 (available with your linux distribution and for macOS from [MacPorts Project](https://www.macports.org/) and [Homebrew](https://brew.sh/) as packages)
 
 ## Option 1: package build (recommended for most users)
 

README.md

@@ -24,6 +24,9 @@ See [changes.md](changes.md) for more details.
 Full installation instructions and a list of the required dependencies can be found 
 in [INSTALL.md](INSTALL.md).
 
+If you are interested in contributing to HElib, please read our 
+[Contributing Guidelines](CONTRIBUTING.md).
+
 HElib is written in C++14 and uses the [NTL mathematical library][4].  
 HElib is distributed under the terms of the [Apache License v2.0][5].  
 

changes.md

@@ -1,3 +1,15 @@
+HElib 1.0.2, June 2020
+===============================
+(tagged as v1.0.2)
+
+April-June 2020
+------------------
+* Source code contribution policy
+* HElib now builds with compiler pedantic flags
+* Consistent C++ format style adopted
+* Improved sampling functions
+* Bug fixes
+
 HElib 1.0.1, April 2020
 ===============================
 (tagged as v1.0.1)