developer:contribution_guidelines
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
developer:contribution_guidelines [2015/03/01 13:43] Juan Osorio Robles |
developer:contribution_guidelines [2016/02/05 20:43] (current) Christopher Price |
||
|---|---|---|---|
| Line 15: | Line 15: | ||
| * Provide a detailed description of the change in the following lines. Use breaking paragraphs where needed. | * Provide a detailed description of the change in the following lines. Use breaking paragraphs where needed. | ||
| * The first line should be limited to 50 characters; should be written in present tense; and should not end with a period. | * The first line should be limited to 50 characters; should be written in present tense; and should not end with a period. | ||
| - | * Subsequent lines should be wrapped at 70 characters. | + | * Subsequent lines should be wrapped at 72 characters. |
| === Commit message content === | === Commit message content === | ||
| Line 32: | Line 32: | ||
| === General Code headers === | === General Code headers === | ||
| - | Headers must be applied to all contributed code. These should provide a copyright notice identifying the individual, and company where affiliated, of origin for the contribution and the licence under which the contribution was made. In OPNFV we use the Apache 2.0 license, some templates for code headers follow. | + | Headers must be applied to all contributed code. These should provide a copyright notice identifying the individual, and company where affiliated, of origin for the contribution and the license under which the contribution was made. In OPNFV we use the Apache 2.0 license, some templates for code headers follow. |
| == C/C++/Java == | == C/C++/Java == | ||
| Line 65: | Line 65: | ||
| %% which accompanies this distribution, and is available at%%\\ | %% which accompanies this distribution, and is available at%%\\ | ||
| %% http://www.apache.org/licenses/LICENSE-2.0-->%%\\ | %% http://www.apache.org/licenses/LICENSE-2.0-->%%\\ | ||
| + | |||
| + | == Documentation == | ||
| + | |||
| + | Per [[https://www.opnfv.org/about/bylaws-and-policies/ip-policy|OPNFV IP Policy]], all documentation will be received and made available by the OPNFV Project under the Creative Commons Attribution 4.0 International License. | ||
| + | |||
| + | All documentation files need to be licensed using the creative commons licence. The following example may be applied in the first lines of all contributed RST files: | ||
| + | |||
| + | .. This work is licensed under a Creative Commons Attribution 4.0 International License. | ||
| + | .. http://creativecommons.org/licenses/by/4.0 | ||
| + | .. (c) <optionally add copywriters name> | ||
| + | |||
| + | These lines will not be rendered in the html and pdf files. | ||
| + | |||
| === General Code Style === | === General Code Style === | ||
| Line 85: | Line 98: | ||
| The usage of tools such as [[https://pypi.python.org/pypi/flake8|flake8]] is encouraged. | The usage of tools such as [[https://pypi.python.org/pypi/flake8|flake8]] is encouraged. | ||
| - | |||
developer/contribution_guidelines.1425217401.txt.gz ยท Last modified: 2015/03/01 13:43 by Juan Osorio Robles
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: Creative Commons Attribution 4.0 International License
