forked from pulp/pulp-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[noissue]
- Loading branch information
Showing
11 changed files
with
545 additions
and
213 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
[bumpversion] | ||
current_version = 0.1.0a1.dev | ||
commit = False | ||
tag = False | ||
parse = (?P<major>\d+)\.(?P<minor>\d+)\.(0a)?(?P<patch>\d+)(\.(?P<release>[a-z]+))? | ||
serialize = | ||
{major}.{minor}.0a{patch}.{release} | ||
{major}.{minor}.0a{patch} | ||
|
||
[bumpversion:part:release] | ||
optional_value = prod | ||
first_value = dev | ||
values = | ||
dev | ||
prod | ||
|
||
"[bumpversion:file:./pulp_docs/app/__init__.py]" | ||
|
||
[bumpversion:file:./setup.py] | ||
|
||
[bumpversion:file:./docs/conf.py] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
========= | ||
Changelog | ||
========= | ||
|
||
.. | ||
You should *NOT* be adding new change log entries to this file, this | ||
file is managed by towncrier. You *may* edit previous change logs to | ||
fix problems like typo corrections or such. | ||
To add a new change log entry, please see | ||
https://docs.pulpproject.org/pulpcore/contributing/git.html#changelog-update | ||
WARNING: Don't drop the next directive! | ||
|
||
.. towncrier release notes start | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
GPL Cooperation Commitment, version 1.0 | ||
|
||
Before filing or continuing to prosecute any legal proceeding or claim | ||
(other than a Defensive Action) arising from termination of a Covered | ||
License, we commit to extend to the person or entity ('you') accused | ||
of violating the Covered License the following provisions regarding | ||
cure and reinstatement, taken from GPL version 3. As used here, the | ||
term 'this License' refers to the specific Covered License being | ||
enforced. | ||
|
||
However, if you cease all violation of this License, then your | ||
license from a particular copyright holder is reinstated (a) | ||
provisionally, unless and until the copyright holder explicitly | ||
and finally terminates your license, and (b) permanently, if the | ||
copyright holder fails to notify you of the violation by some | ||
reasonable means prior to 60 days after the cessation. | ||
|
||
Moreover, your license from a particular copyright holder is | ||
reinstated permanently if the copyright holder notifies you of the | ||
violation by some reasonable means, this is the first time you | ||
have received notice of violation of this License (for any work) | ||
from that copyright holder, and you cure the violation prior to 30 | ||
days after your receipt of the notice. | ||
|
||
We intend this Commitment to be irrevocable, and binding and | ||
enforceable against us and assignees of or successors to our | ||
copyrights. | ||
|
||
Definitions | ||
|
||
'Covered License' means the GNU General Public License, version 2 | ||
(GPLv2), the GNU Lesser General Public License, version 2.1 | ||
(LGPLv2.1), or the GNU Library General Public License, version 2 | ||
(LGPLv2), all as published by the Free Software Foundation. | ||
|
||
'Defensive Action' means a legal proceeding or claim that We bring | ||
against you in response to a prior proceeding or claim initiated by | ||
you or your affiliate. | ||
|
||
'We' means each contributor to this repository as of the date of | ||
inclusion of this file, including subsidiaries of a corporate | ||
contributor. | ||
|
||
This work is available under a [Creative Commons Attribution-ShareAlike 4.0 International license] | ||
(https://creativecommons.org/licenses/by-sa/4.0/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
Contributing | ||
============ | ||
|
||
To contribute to the ``pulp-docs`` package follow this process: | ||
|
||
1. Clone the GitHub repo | ||
2. Make a change | ||
3. Make sure all tests passed | ||
4. Add a file into CHANGES folder (Changelog update). | ||
5. Commit changes to own ``pulp_docs`` clone | ||
6. Make pull request from github page for your clone against branch | ||
|
||
|
||
.. _changelog-update: | ||
|
||
Changelog update | ||
**************** | ||
|
||
The CHANGES.rst file is managed using the `towncrier tool <https://github.com/hawkowl/towncrier>`_ | ||
and all non trivial changes must be accompanied by a news entry. | ||
|
||
To add an entry to the news file, you first need an issue in pulp.plan.io describing the change you | ||
want to make. Once you have an issue, take its number and create a file inside of the ``CHANGES/`` | ||
directory named after that issue number with an extension of .feature, .bugfix, .doc, .removal, or | ||
.misc. So if your issue is 3543 and it fixes a bug, you would create the file | ||
``CHANGES/3543.bugfix``. | ||
|
||
PRs can span multiple categories by creating multiple files (for instance, if you added a feature | ||
and deprecated an old feature at the same time, you would create CHANGES/NNNN.feature and | ||
CHANGES/NNNN.removal). Likewise if a PR touches multiple issues/PRs you may create a file for each | ||
of them with the exact same contents and Towncrier will deduplicate them. | ||
|
||
The contents of this file are reStructuredText formatted text that will be used as the content of | ||
the news file entry. You do not need to reference the issue or PR numbers here as towncrier will | ||
automatically add a reference to all of the affected issues when rendering the news file. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
Copyright © 2017 Pulp Project developers. | ||
|
||
This software is licensed to you under the GNU General Public | ||
License as published by the Free Software Foundation; either version | ||
2 of the License (GPLv2) or (at your option) any later version. | ||
There is NO WARRANTY for this software, express or implied, | ||
including the implied warranties of MERCHANTABILITY, | ||
NON-INFRINGEMENT, or FITNESS FOR A PARTICULAR PURPOSE. You should | ||
have received a copy of GPLv2 along with this software; if not, see | ||
http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt. |
Empty file.
Oops, something went wrong.