Update contributing guidelines.
* Align CONTRIBUTING.md with the google/new-project template. * Explain the support story for the CMake config. PiperOrigin-RevId: 421311695
This commit is contained in:
committed by
Victor Costan
parent
65dc7b3839
commit
8b07ff196a
26
README.md
26
README.md
@@ -131,6 +131,32 @@ should provide a reasonably balanced starting point for benchmarking. (Note that
|
||||
baddata[1-3].snappy are not intended as benchmarks; they are used to verify
|
||||
correctness in the presence of corrupted data in the unit test.)
|
||||
|
||||
Contributing to the Snappy Project
|
||||
==================================
|
||||
|
||||
In addition to the aims listed at the top of the [README](README.md) Snappy
|
||||
explicitly supports the following:
|
||||
|
||||
1. C++11
|
||||
2. Clang (gcc and MSVC are best-effort).
|
||||
3. Low level optimizations (e.g. assembly or equivalent intrinsics) for:
|
||||
1. [x86](https://en.wikipedia.org/wiki/X86)
|
||||
2. [x86-64](https://en.wikipedia.org/wiki/X86-64)
|
||||
3. ARMv7 (32-bit)
|
||||
4. ARMv8 (AArch64)
|
||||
4. Supports only the Snappy compression scheme as described in
|
||||
[format_description.txt](format_description.txt).
|
||||
5. CMake for building
|
||||
|
||||
Changes adding features or dependencies outside of the core area of focus listed
|
||||
above might not be accepted. If in doubt post a message to the
|
||||
[Snappy discussion mailing list](https://groups.google.com/g/snappy-compression).
|
||||
|
||||
We are unlikely to accept contributions to the build configuration files, such
|
||||
as `CMakeLists.txt`. We are focused on maintaining a build configuration that
|
||||
allows us to test that the project works in a few supported configurations
|
||||
inside Google. We are not currently interested in supporting other requirements,
|
||||
such as different operating systems, compilers, or build systems.
|
||||
|
||||
Contact
|
||||
=======
|
||||
|
||||
Reference in New Issue
Block a user