-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdeveloper.html
263 lines (181 loc) · 10.1 KB
/
developer.html
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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1"><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Developer Guidelines</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/theme.css " type="text/css" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<!-- sphinx script_files -->
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<!-- bundled in js (rollup iife) -->
<!-- <script src="_static/theme-vendors.js"></script> -->
<script src="_static/theme.js" defer></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="License" href="license.html" />
<link rel="prev" title="Technical implementation" href="technical_implementation.html" />
</head>
<body>
<div id="app">
<div class="theme-container" :class="pageClasses"><navbar @toggle-sidebar="toggleSidebar">
<router-link to="index.html" class="home-link">
<span class="site-name">Fritz Marshal</span>
</router-link>
<div class="links">
<navlinks class="can-hide">
</navlinks>
</div>
</navbar>
<div class="sidebar-mask" @click="toggleSidebar(false)">
</div>
<sidebar @toggle-sidebar="toggleSidebar">
<navlinks>
</navlinks><div id="searchbox" class="searchbox" role="search">
<div class="caption"><span class="caption-text">Quick search</span>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Search" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
</div><div class="sidebar-links" role="navigation" aria-label="main navigation">
<div class="sidebar-group">
<p class="caption">
<span class="caption-text"><a href="index.html#fritz-marshal-manual">fritz marshal manual</a></span>
</p>
<ul class="current">
<li class="toctree-l1 ">
<a href="user_guide.html" class="reference internal ">Fritz User Guide</a>
</li>
<li class="toctree-l1 ">
<a href="run_your_own.html" class="reference internal ">Run your own Fritz</a>
</li>
<li class="toctree-l1 ">
<a href="api.html" class="reference internal ">API</a>
</li>
<li class="toctree-l1 ">
<a href="catalogs.html" class="reference internal ">Kowalski collection schemas</a>
</li>
<li class="toctree-l1 ">
<a href="technical_implementation.html" class="reference internal ">Technical implementation</a>
</li>
<li class="toctree-l1 current">
<a href="#" class="reference internal current">Developer Guidelines</a>
<ul>
<li class="toctree-l2"><a href="#how-to-contribute" class="reference internal">How to contribute</a></li>
<li class="toctree-l2"><a href="#setting-up-your-environment" class="reference internal">Setting up your environment</a></li>
</ul>
</li>
<li class="toctree-l1 ">
<a href="license.html" class="reference internal ">License</a>
</li>
</ul>
</div>
</div>
</sidebar>
<page>
<div class="body-header" role="navigation" aria-label="navigation">
<ul class="breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>Developer Guidelines</li>
</ul>
<ul class="page-nav">
<li class="prev">
<a href="technical_implementation.html"
title="previous chapter">← Technical implementation</a>
</li>
<li class="next">
<a href="license.html"
title="next chapter">License →</a>
</li>
</ul>
</div>
<hr>
<div class="content" role="main" v-pre>
<section id="developer-guidelines">
<h1>Developer Guidelines<a class="headerlink" href="#developer-guidelines" title="Link to this heading">¶</a></h1>
<section id="how-to-contribute">
<h2>How to contribute<a class="headerlink" href="#how-to-contribute" title="Link to this heading">¶</a></h2>
<p>Contributions to Fritz are made through <a class="reference external" href="https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests">GitHub Pull Requests</a>, a set of proposed commits (or patches).</p>
<p>To prepare, you should:</p>
<ul>
<li><p>Create your own fork the <a class="reference external" href="https://github.com/fritz-marshal/fritz">fritz repository</a> by clicking the “fork” button.</p></li>
<li><p><a class="reference external" href="https://help.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh">Set up SSH authentication with GitHub</a>.</p></li>
<li><p>Clone (download) your copy of the repository, and set up a remote called <code class="docutils literal notranslate"><span class="pre">upstream</span></code> that points to the main Fritz repository.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>clone<span class="w"> </span>[email protected]:yourname/fritz
git<span class="w"> </span>remote<span class="w"> </span>add<span class="w"> </span>upstream<span class="w"> </span>[email protected]:fritz-marshal/fritz
</pre></div>
</div>
</li>
</ul>
<p>Then, for each feature you wish to contribute, create a pull request:</p>
<ol class="arabic">
<li><p>Download the latest version of Fritz, and create a new branch for your work.</p>
<p>Here, let’s say we want to contribute some documentation fixes; we’ll call our branch <code class="docutils literal notranslate"><span class="pre">rewrite-contributor-guide</span></code>.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>checkout<span class="w"> </span>master
git<span class="w"> </span>pull<span class="w"> </span>upstream<span class="w"> </span>master
git<span class="w"> </span>checkout<span class="w"> </span>-b<span class="w"> </span>rewrite-contributor-guide
</pre></div>
</div>
</li>
<li><p>Make modifications to Fritz and commit your changes using <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">add</span></code> and <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">commit</span></code>. Each commit message should consist of a summary line and a longer description, e.g.:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>Rewrite the contributor guide
While reading through the contributor guide, I noticed several places
in which instructions were out of order. I therefore reorganized all
sections to follow logically, and fixed several grammar mistakes along
the way.
</pre></div>
</div>
</li>
<li><p>When ready, push your branch to GitHub:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>push<span class="w"> </span>origin<span class="w"> </span>rewrite-contributor-guide
</pre></div>
</div>
<p>Once the branch is uploaded, GitHub should print a URL for turning your branch into a pull request. Open that URL in your browser, write an informative title and description for your pull request, and submit it.</p>
</li>
<li><p>The Fritz will now review your contribution, and suggest changes. <em>To simplify review, please limit pull requests to one logical set of changes.</em> To incorporate changes recommended by the reviewers, commit edits to your branch, and push to the branch again (there is no need to re-create the pull request, it will automatically track modifications to your branch).</p></li>
<li><p>Once the pull request has been reviewed and approved by at least two team members, it will be merged into Fritz.</p></li>
</ol>
</section>
<section id="setting-up-your-environment">
<h2>Setting up your environment<a class="headerlink" href="#setting-up-your-environment" title="Link to this heading">¶</a></h2>
<p>We use flake8 to verify that code complies with <a class="reference external" href="https://www.python.org/dev/peps/pep-0008/">PEP8</a>. Please install the git pre-commit hook using:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>./fritz<span class="w"> </span>developer
</pre></div>
</div>
<p>The pre-commit hook will lint <em>changes</em> made to the source. To lint
the entire repository, use:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>./fritz<span class="w"> </span>lint
</pre></div>
</div>
</section>
</section>
</div>
<div class="page-nav">
<div class="inner"><ul class="page-nav">
<li class="prev">
<a href="technical_implementation.html"
title="previous chapter">← Technical implementation</a>
</li>
<li class="next">
<a href="license.html"
title="next chapter">License →</a>
</li>
</ul><div class="footer" role="contentinfo">
© Copyright 2020, The Fritz Marshal authors.
<br>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.4.7 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a> 0.9.1.
</div>
</div>
</div>
</page>
</div></div>
</body>
</html>