Skip to content

F
faiss
Commit d08ac922 authored by mdouze's avatar mdouze Committed by GitHub
Browse files
Options

Update CONTRIBUTING.md

parent ab50f0ae
Show whitespace changes
Inline Side-by-side
Showing with 6 additions and 5 deletions
CONTRIBUTING.md
View file @ d08ac922
...@@ -10,7 +10,9 @@ github version of Faiss with the internal state. ...@@ -10,7 +10,9 @@ github version of Faiss with the internal state.
## Pull Requests ## 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`. 1. Fork the repo and create your branch from `master`.
2. If you've added code that should be tested, add tests. 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 ...@@ -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. outlined on that page and do not file a public issue.
## Coding Style ## Coding Style
* 4 spaces for indentation rather than tabs * 4 spaces for indentation rather than tabs
* 80 character line length * 80 character line length
* C++03 for the main Faiss * C++03 for the main Faiss, C++11 for the GPU part
## License ## License
By contributing to Faiss, you agree that your contributions will be licensed By contributing to Faiss, you agree that your contributions will be licensed
under the LICENSE file in the root directory of this source tree. under the LICENSE file in the root directory of this source tree.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment