Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Docs] Add note on module development about the copyrights #26812

Merged
merged 4 commits into from
Jul 19, 2017
Merged

[Docs] Add note on module development about the copyrights #26812

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0439fa5
Add note on module development about the copyrights
ryansb Jul 14, 2017
cabcfd3
Add recommendation for standardizing on `Copyright (c) 2017 Ansible P…
ryansb Jul 18, 2017
b51e92d
s/with/should have/
ryansb Jul 18, 2017
a250713
Fix more unicode
ryansb Jul 18, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
23 changes: 12 additions & 11 deletions docs/docsite/rst/dev_guide/developing_modules_documenting.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,21 +34,22 @@ All modules must have the following sections defined in this order:
Copyright
----------------------

The first 3 lines of every module should look the same. The first line is the
shebang, but the next 2 lines are the important bit: copyright statement and
license.
The beginning of every module should look about the same. After the shebang,
there should be at least two lines covering copyright and licensing of the
code.

.. code-block:: python

#!/usr/bin/python
# Copyright © 2017 [REPLACE THIS]
# Copyright (c) 2017 Ansible Project
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

Every file with a copyright header must include the original author. Major
additions to the module are allowed to add an additional copyright line. This
is especially true of rewrites, but original authorship copyright messages
should be preserved. If applicable, contributors may have their rights assigned
to their employer for example: "Copyright © 2017 Red Hat, Inc."
Every file with a copyright line with the original copyright holder. Major
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please change "with" to "should have"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

additions to the module (for instance, rewrites) may add additional copyright
lines. Code from the Ansible community should typically be assigned as
"Copyright (c) 2017 Ansible Project" which covers all contributors. Any legal
questions need to review the source control history, so an exhaustive copyright
header is not necessary.

The license declaration should be ONLY one line, not the full GPL prefix. If
you notice a module with the full prefix, feel free to switch it to the
Expand All @@ -60,8 +61,8 @@ add the newer line above the older one, like so:
.. code-block:: python

#!/usr/bin/python
# Copyright © 2017 [New Contributor(s)]
# Copyright © 2015 [Original Contributor(s)]
# Copyright (c) 2017 [New Contributor(s)]
# Copyright (c) 2015 [Original Contributor(s)]
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)


Expand Down