max/lean4-htt
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 2

chore(.github/CONTRIBUTING.md): update PR submission guidelines.

Browse source
This commit is contained in:
Leonardo de Moura 2017-08-16 14:22:32 -07:00
parent 12b28546e8
commit dbfee23682
1 changed files with 7 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
.github/CONTRIBUTING.md vendored
View file

@ -22,8 +22,13 @@ for you (the contributors) and us (the maintainers).
# Opening Pull Requests
The core developers have to maintain Lean. Thus, they need to read all PRs, and make sure they can maintain them.
So, here are some guidelines for submitting PRs:
- Small bug fixes are always welcome.
- Before implementing a major feature or refactoring the code, please ask whether the change is welcome or not.
The worst kind of PR is the "unwanted one". That is, we don’t want it, but we have to explain why we will not merge it.
- Ensure all test suite works before submitting a PR.
- Ensure your Pull Request meets the coding and commit conventions documented above.
- Ensure your Pull Request contains tests for the behavior, for both features or
bug fixes.
- If you are not proficient in C++, do not submit PRs with C++ code.