-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathcontribute.html
More file actions
315 lines (198 loc) · 12.6 KB
/
contribute.html
File metadata and controls
315 lines (198 loc) · 12.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>14. Contribute — Keypirinha</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="shortcut icon" href="_static/favicon.ico"/>
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="15. Glossary" href="glossary.html" />
<link rel="prev" title="13.3. Embedded Python Interpreter" href="api/python.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home" alt="Documentation Home"> Keypirinha
<img src="_static/app-128.png" class="logo" alt="Logo"/>
</a>
<div class="version">
2.26
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="download.html">1. Download</a></li>
<li class="toctree-l1"><a class="reference internal" href="install.html">2. Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="update.html">3. Update Procedure</a></li>
<li class="toctree-l1"><a class="reference internal" href="first.html">4. First steps</a></li>
<li class="toctree-l1"><a class="reference internal" href="shipped-packages.html">5. Shipped Packages</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributions.html">6. Third-Party Packages</a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">7. Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="theming.html">8. Theming</a></li>
<li class="toctree-l1"><a class="reference internal" href="keyboard.html">9. Keyboard Shortcuts</a></li>
<li class="toctree-l1"><a class="reference internal" href="custom-catalog.html">10. Customize your Catalog</a></li>
<li class="toctree-l1"><a class="reference internal" href="architecture.html">11. Architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="packages.html">12. Packages Structure</a></li>
<li class="toctree-l1"><a class="reference internal" href="api.html">13. Extending Keypirinha (API)</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">14. Contribute</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#how-to-report-an-issue">14.1. How to Report an Issue</a></li>
<li class="toctree-l2"><a class="reference internal" href="#get-involved-in-the-development-of-the-packages-and-or-the-api">14.2. Get involved in the development of the Packages and/or the API</a></li>
<li class="toctree-l2"><a class="reference internal" href="#get-involved-in-the-development-of-the-platform">14.3. Get involved in the development of the Platform</a></li>
<li class="toctree-l2"><a class="reference internal" href="#help-with-the-documentation">14.4. Help with the Documentation</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="glossary.html">15. Glossary</a></li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">16. Frequently Asked Questions (FAQ)</a></li>
<li class="toctree-l1"><a class="reference internal" href="credits.html">17. Credits</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Change Log</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Keypirinha</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> »</li>
<li><span class="section-number">14. </span>Contribute</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="contribute">
<h1><span class="section-number">14. </span>Contribute<a class="headerlink" href="#contribute" title="Permalink to this headline">¶</a></h1>
<div class="section" id="how-to-report-an-issue">
<span id="contribute-issue"></span><h2><span class="section-number">14.1. </span>How to Report an Issue<a class="headerlink" href="#how-to-report-an-issue" title="Permalink to this headline">¶</a></h2>
<p>An <a class="reference external" href="https://github.com/Keypirinha/Keypirinha/issues">Official Bug Tracker</a> accepts any issue report or suggestion related to the
application or an official <a class="reference internal" href="glossary.html#term-Package"><span class="xref std std-term">package</span></a>.</p>
<p>Here are some guidelines to report an issue. Please follow them! To accurately
report an issue strongly increases the chances of your issue to be fixed
quickly.</p>
<ul class="simple">
<li><p>Ensure your are running the latest version of Keypirinha</p></li>
<li><p>Search if your issue has been reported already</p></li>
<li><p>Check if some warning/error message has been printed on the <a class="reference internal" href="glossary.html#term-Console"><span class="xref std std-term">Console</span></a></p></li>
<li><p>One bug per report</p></li>
<li><p>Describe the issue clearly, in English. Bullet points are good</p></li>
<li><p>Provide step-by-step instructions so we can reproduce the issue (we can’t fix
what we can’t reproduce).</p>
<ul>
<li><p>What steps will reproduce the problem?</p></li>
<li><p>What is the expected output/behavior?</p></li>
<li><p>What do you see instead?</p></li>
</ul>
</li>
<li><p>Optionally attach screenshots so we can “see” the issue</p></li>
<li><p>Workarounds or other related tips on how to avoid the issue are welcome</p></li>
</ul>
</div>
<div class="section" id="get-involved-in-the-development-of-the-packages-and-or-the-api">
<span id="contribute-packages"></span><h2><span class="section-number">14.2. </span>Get involved in the development of the Packages and/or the API<a class="headerlink" href="#get-involved-in-the-development-of-the-packages-and-or-the-api" title="Permalink to this headline">¶</a></h2>
<p>If you are not sure where to start from, some feature requests or issues
reported by users may be associated with the <a class="reference external" href="https://github.com/Keypirinha/Keypirinha/issues?q=is%3Aissue+is%3Aopen+label%3Acontrib-appreciated">contrib-appreciated</a>
tag.</p>
<p>This tag usually involves a development task that can be done in the
<a class="reference external" href="https://github.com/Keypirinha/Packages">Packages Repository</a> and/or the <a class="reference external" href="https://github.com/Keypirinha/PythonLib">Python Lib Repository</a> (i.e. the exposed Python API of
Keypirinha).</p>
<p>Both repositories welcome <em>Pull Requests</em>. See their respective <code class="docutils literal notranslate"><span class="pre">README</span></code> file
for more details on how to contribute.</p>
</div>
<div class="section" id="get-involved-in-the-development-of-the-platform">
<span id="contribute-platform"></span><h2><span class="section-number">14.3. </span>Get involved in the development of the Platform<a class="headerlink" href="#get-involved-in-the-development-of-the-platform" title="Permalink to this headline">¶</a></h2>
<p>Keypirinha is looking for an involved developer to help creating its online
platform dedicated to the automated redistribution of plugins (i.e. website and
service).</p>
<p><strong>The project</strong></p>
<ul class="simple">
<li><p>Code would be fully open source</p></li>
<li><p>It mainly consists of a website and a service to be accessed by Keypirinha
itself</p></li>
<li><p>It will include current Keypirinha’s website (documentation)</p></li>
<li><p>Its main language would be Python3</p></li>
<li><p>It must run on a Linux platform</p></li>
</ul>
<p><strong>About you</strong></p>
<ul class="simple">
<li><p>You want to improve Keypirinha</p></li>
<li><p>You want to spend some of your free time on a long run project</p></li>
<li><p>You are of the kind who like to get the job done</p></li>
<li><p>You are willing to enter a friendly online relationship with an other
developer for the good of a project :)</p></li>
</ul>
<p><strong>Application</strong></p>
<p>Please PM <a class="reference external" href="https://gitter.im/polyvertex">@polyvertex</a></p>
<p><em>@polyvertex</em> is a former long-term traveler who values humanized and friendly
online relationships between developers. Having a beer (or five) with him
somewhere, someday, will be part of the deal :)</p>
</div>
<div class="section" id="help-with-the-documentation">
<span id="contribute-doc"></span><h2><span class="section-number">14.4. </span>Help with the Documentation<a class="headerlink" href="#help-with-the-documentation" title="Permalink to this headline">¶</a></h2>
<p>Please file an issue on the <a class="reference external" href="https://github.com/Keypirinha/Keypirinha/issues">Official Bug Tracker</a> if you noticed a mistake (language
or technical), if you have some comment or if you wish to make some improvement.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="glossary.html" class="btn btn-neutral float-right" title="15. Glossary" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="api/python.html" class="btn btn-neutral float-left" title="13.3. Embedded Python Interpreter" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2013-2018, Jean-Charles Lefebvre
</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-74522446-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>