| OLD | NEW |
| 1 # -*- coding: utf-8 -*- |
| 1 # Copyright 2012 Google Inc. All Rights Reserved. | 2 # Copyright 2012 Google Inc. All Rights Reserved. |
| 2 # | 3 # |
| 3 # Licensed under the Apache License, Version 2.0 (the "License"); | 4 # Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 # you may not use this file except in compliance with the License. | 5 # you may not use this file except in compliance with the License. |
| 5 # You may obtain a copy of the License at | 6 # You may obtain a copy of the License at |
| 6 # | 7 # |
| 7 # http://www.apache.org/licenses/LICENSE-2.0 | 8 # http://www.apache.org/licenses/LICENSE-2.0 |
| 8 # | 9 # |
| 9 # Unless required by applicable law or agreed to in writing, software | 10 # Unless required by applicable law or agreed to in writing, software |
| 10 # distributed under the License is distributed on an "AS IS" BASIS, | 11 # distributed under the License is distributed on an "AS IS" BASIS, |
| 11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | 12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 # See the License for the specific language governing permissions and | 13 # See the License for the specific language governing permissions and |
| 13 # limitations under the License. | 14 # limitations under the License. |
| 15 """Additional help about contributing code to gsutil.""" |
| 14 | 16 |
| 15 from gslib.help_provider import HELP_NAME | 17 from __future__ import absolute_import |
| 16 from gslib.help_provider import HELP_NAME_ALIASES | 18 |
| 17 from gslib.help_provider import HELP_ONE_LINE_SUMMARY | |
| 18 from gslib.help_provider import HelpProvider | 19 from gslib.help_provider import HelpProvider |
| 19 from gslib.help_provider import HELP_TEXT | |
| 20 from gslib.help_provider import HelpType | |
| 21 from gslib.help_provider import HELP_TYPE | |
| 22 | 20 |
| 23 _detailed_help_text = (""" | 21 _DETAILED_HELP_TEXT = (""" |
| 24 <B>OVERVIEW</B> | 22 <B>OVERVIEW</B> |
| 25 We're open to incorporating gsutil code changes authored by users. Here | 23 We're open to incorporating gsutil code changes authored by users. Here |
| 26 are some guidelines: | 24 are some guidelines: |
| 27 | 25 |
| 28 1. Before we can accept code submissions, we have to jump a couple of legal | 26 1. Before we can accept code submissions, we have to jump a couple of legal |
| 29 hurdles. Please fill out either the individual or corporate Contributor | 27 hurdles. Please fill out either the individual or corporate Contributor |
| 30 License Agreement: | 28 License Agreement: |
| 31 | 29 |
| 32 - If you are an individual writing original source code and you're | 30 - If you are an individual writing original source code and you're |
| 33 sure you own the intellectual property, | 31 sure you own the intellectual property, |
| (...skipping 93 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 127 http://code.google.com/p/rietveld/wiki/UploadPyUsage | 125 http://code.google.com/p/rietveld/wiki/UploadPyUsage |
| 128 - Run upload.py from your git directory with the changes. | 126 - Run upload.py from your git directory with the changes. |
| 129 - Click the codereview.appspot.com link it generates, click "Edit Issue", | 127 - Click the codereview.appspot.com link it generates, click "Edit Issue", |
| 130 and add mfschwartz@google.com as a reviewer, and Cc gs-team@google.com. | 128 and add mfschwartz@google.com as a reviewer, and Cc gs-team@google.com. |
| 131 - Click Publish+Mail Comments. | 129 - Click Publish+Mail Comments. |
| 132 - Once your changes are accepted, submit a pull request on GitHub and we | 130 - Once your changes are accepted, submit a pull request on GitHub and we |
| 133 will merge your commits. | 131 will merge your commits. |
| 134 """) | 132 """) |
| 135 | 133 |
| 136 | 134 |
| 137 | |
| 138 class CommandOptions(HelpProvider): | 135 class CommandOptions(HelpProvider): |
| 139 """Additional help about contributing code to gsutil.""" | 136 """Additional help about contributing code to gsutil.""" |
| 137 # TODO: gsutil-beta: Add lint .rc file and linting instructions. |
| 140 | 138 |
| 141 help_spec = { | 139 # Help specification. See help_provider.py for documentation. |
| 142 # Name of command or auxiliary help info for which this help applies. | 140 help_spec = HelpProvider.HelpSpec( |
| 143 HELP_NAME : 'dev', | 141 help_name='dev', |
| 144 # List of help name aliases. | 142 help_name_aliases=[ |
| 145 HELP_NAME_ALIASES : ['development', 'developer', 'code', 'mods', | 143 'development', 'developer', 'code', 'mods', 'software'], |
| 146 'software'], | 144 help_type='additional_help', |
| 147 # Type of help: | 145 help_one_line_summary='Contributing Code to gsutil', |
| 148 HELP_TYPE : HelpType.ADDITIONAL_HELP, | 146 help_text=_DETAILED_HELP_TEXT, |
| 149 # One line summary of this help. | 147 subcommand_help_text={}, |
| 150 HELP_ONE_LINE_SUMMARY : 'Contributing Code to gsutil', | 148 ) |
| 151 # The full help text. | |
| 152 HELP_TEXT : _detailed_help_text, | |
| 153 } | |
| OLD | NEW |