ericLemanissier/conan-center-index
1
0
Fork 1
mirror of https://github.com/conan-io/conan-center-index.git synced 2025-08-14 02:35:37 +00:00
Code Issues 6 Packages Projects Releases Wiki Activity

(#4430) Update reviewing.md

Browse Source 
* Update reviewing.md

* Typo

* Update docs/reviewing.md

Co-authored-by: Yoann Potinet <intelligide@hotmail.fr>

Co-authored-by: Uilian Ries <uilianries@gmail.com>
Co-authored-by: Yoann Potinet <intelligide@hotmail.fr>
This commit is contained in:
Chris Mc
2021-02-03 09:01:25 -05:00
committed by GitHub
parent acdf4fd635
commit 4055f34fdf
1 changed files with 17 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/reviewing.md
View File

@@ -15,7 +15,7 @@ Avoid trailing white-space characters, if possible
## Quotes
If possible, try to avoid mixing single quotes (`'`) and double quotes (`"`) in python code (`conanfile.py`, `test_package/conanfile.py`). Consistency in preferred.
If possible, try to avoid mixing single quotes (`'`) and double quotes (`"`) in python code (`conanfile.py`, `test_package/conanfile.py`). Consistency is preferred.
## Order of methods and attributes
@@ -41,4 +41,19 @@ Prefer the following order of documented methods in python code (`conanfile.py`,
- deploy
- test
the order above resembles the execution order of methods on CI. therefore, for instance, `build` is always executed before `package` method, so `build` should appear before the `package` in `conanfile.py`.
the order above resembles the execution order of methods on CI. therefore, for instance, `build` is always executed before `package` method, so `build` should appear before the
`package` in `conanfile.py`.
## Test Package
### Minimalistic Source Code
The contents of `test_package.c` or `test_package.cpp` should be as minimal as possible, including a few headers at most with simple instatiation of objects to ensure linkage
and dependencies are correct.
### Verifying Components
When components are defined in the `package_info` in `conanfile.py` the following conditions are desired
- use the `cmake_find_package` or `cmake_find_package_multi` generators in `test_package/conanfile.py`
- corresponding call to `find_package()` with the components _explicitly_ used in `target_link_libraries`