facebookresearch/faiss
1
0
Fork 0
mirror of https://github.com/facebookresearch/faiss.git synced 2026-10-12 02:13:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
mdouze
2017-03-01 11:16:12 +01:00
committed by GitHub
parent ab50f0ae4b
commit d08ac922df
1 changed files with 8 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+8 -7
View File
@@ -1,16 +1,18 @@
# Contributing to Faiss
We want to make contributing to this project as easy and transparent as
possible.
possible.
## Our Development Process
We mainly develop Faiss within Facebook. Sometimes, we will sync the
github version of Faiss with the internal state.
github version of Faiss with the internal state.
## Pull Requests
We welcome pull requests that add significant value to Faiss.
We welcome pull requests that add significant value to Faiss. If you plan to do
a major development and contribute it back to Faiss, please contact us first before
putting too much effort into it.
1. Fork the repo and create your branch from `master`.
2. If you've added code that should be tested, add tests.
@@ -39,14 +41,13 @@ disclosure of security bugs. In those cases, please go through the process
outlined on that page and do not file a public issue.
## Coding Style
* 4 spaces for indentation rather than tabs
* 80 character line length
* C++03 for the main Faiss
* C++03 for the main Faiss, C++11 for the GPU part
## License
By contributing to Faiss, you agree that your contributions will be licensed
under the LICENSE file in the root directory of this source tree.