-
Notifications
You must be signed in to change notification settings - Fork 1
/
Development_workflow.html
239 lines (206 loc) · 9.71 KB
/
Development_workflow.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
<!DOCTYPE html>
<html lang="en">
<head>
<base href=".">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Development Workflow</title>
<link rel="stylesheet" href="assets/css/dark-frontend.css" type="text/css" title="dark">
<link rel="alternate stylesheet" href="assets/css/light-frontend.css" type="text/css" title="light">
<link rel="stylesheet" href="assets/css/bootstrap-toc.min.css" type="text/css">
<link rel="stylesheet" href="assets/css/jquery.mCustomScrollbar.min.css">
<link rel="stylesheet" href="assets/js/search/enable_search.css" type="text/css">
<link rel="stylesheet" href="assets/css/prism-tomorrow.css" type="text/css" title="dark">
<link rel="alternate stylesheet" href="assets/css/prism.css" type="text/css" title="light">
<script src="assets/js/mustache.min.js"></script>
<script src="assets/js/jquery.js"></script>
<script src="assets/js/bootstrap.js"></script>
<script src="assets/js/scrollspy.js"></script>
<script src="assets/js/typeahead.jquery.min.js"></script>
<script src="assets/js/search.js"></script>
<script src="assets/js/compare-versions.js"></script>
<script src="assets/js/jquery.mCustomScrollbar.concat.min.js"></script>
<script src="assets/js/bootstrap-toc.min.js"></script>
<script src="assets/js/jquery.touchSwipe.min.js"></script>
<script src="assets/js/anchor.min.js"></script>
<script src="assets/js/tag_filtering.js"></script>
<script src="assets/js/language_switching.js"></script>
<script src="assets/js/styleswitcher.js"></script>
<script src="assets/js/lines_around_headings.js"></script>
<script src="assets/js/prism-core.js"></script>
<script src="assets/js/prism-autoloader.js"></script>
<script src="assets/js/prism_autoloader_path_override.js"></script>
<script src="assets/js/trie.js"></script>
<link rel="shortcut icon" href="assets/images/favicon.png">
</head>
<body class="no-script
">
<script>
$('body').removeClass('no-script');
</script>
<nav class="navbar navbar-fixed-top navbar-default" id="topnav">
<div class="container-fluid">
<div class="navbar-right">
<a id="toc-toggle">
<span class="glyphicon glyphicon-menu-right"></span>
<span class="glyphicon glyphicon-menu-left"></span>
</a>
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar-wrapper" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span title="light mode switch" class="glyphicon glyphicon-sunglasses pull-right" id="lightmode-icon"></span>
<form class="navbar-form pull-right" id="navbar-search-form">
<div class="form-group has-feedback">
<input type="text" class="form-control input-sm" name="search" id="sidenav-lookup-field" placeholder="search" disabled>
<span class="glyphicon glyphicon-search form-control-feedback" id="search-mgn-glass"></span>
</div>
</form>
</div>
<div class="navbar-header">
<a id="sidenav-toggle">
<span class="glyphicon glyphicon-menu-right"></span>
<span class="glyphicon glyphicon-menu-left"></span>
</a>
<a id="home-link" href="index.html" class="hotdoc-navbar-brand">
<img src="assets/images/pitivi.svg" alt="Home">
</a>
</div>
<div class="navbar-collapse collapse" id="navbar-wrapper">
<ul class="nav navbar-nav" id="menu">
</ul>
<div class="hidden-xs hidden-sm navbar-text navbar-center">
<p><b>The Pitivi Developer Documentation</b></p>
</div>
</div>
</div>
</nav>
<main>
<div data-extension="core" data-hotdoc-in-toplevel="True" data-hotdoc-project="Pitivi" data-hotdoc-ref="Development_workflow.html" class="page_container" id="page-wrapper">
<script src="assets/js/utils.js"></script>
<div class="panel panel-collapse oc-collapsed" id="sidenav" data-hotdoc-role="navigation">
<script src="assets/js/full-width.js"></script>
<div id="sitenav-wrapper">
<iframe src="hotdoc-sitemap.html" id="sitenav-frame"></iframe>
</div>
</div>
<div id="body">
<div id="main">
<div id="page-description" data-hotdoc-role="main">
<h1 id="development-workflow">Development Workflow</h1>
<p>We use <a href="https://gitlab.gnome.org/GNOME/pitivi/issues">GitLab</a> to track
all bugs and feature requests. Most of the time, you announce you are
working on an issue, work on it until it's fixed, and then the issue is
closed automatically when a commit with "Fixes #issue_number" is merged.</p>
<p>Interested users can enable notifications for an existing issue to
get an email when it's updated. It's also possible to change your
"Notification settings" for
<a href="https://gitlab.gnome.org/GNOME/pitivi">pitivi</a> from the default
"Global" to "Watch", to receive notifications for any activity in the
entire project.</p>
<h2 id="picking-an-issue-to-work-on">Picking an issue to work on</h2>
<p>To get involved, start with issues tagged
<a href="https://gitlab.gnome.org/GNOME/pitivi/issues?label_name%5B%5D=4.+Newcomers">4. Newcomers</a>.
It's best to get in touch with us in our <a href="https://www.pitivi.org/contact/">chat
room</a>, to see if it's still meaningful, etc.</p>
<p>Once you decide, add a comment on the issue saying you're working on it.</p>
<h2 id="fixing-the-issue">Fixing the issue</h2>
<p>Next is the fun part where you implement your cool feature, or fix an
annoying bug:</p>
<h3 id="create-a-new-git-branch">Create a new git branch</h3>
<p>Create a new branch with a relevant name in your local git repository.</p>
<pre><code>$ git checkout -b feature_name origin/master
</code></pre>
<h3 id="commit-your-changes">Commit your changes</h3>
<p>Once you have made your changes, commit them in your local git
repository. Follow the <a href="https://wiki.gnome.org/Newcomers/CodeContributionWorkflow#Commit_guidelines">GNOME
guidelines</a>
for creating commits.</p>
<p>Be aware that when you create a commit, <code>pre-commit</code> is executed to
perform checks on the changes. In some cases it does some automatic
fixes – when this happens, make sure those are included in the commit
you want to create.</p>
<h3 id="propose-your-patches">Propose your patches</h3>
<p>Patches are proposed by creating a merge request in GitLab.</p>
<p>To do this, you need your own Pitivi repo on <a href="https://gitlab.gnome.org">GNOME's
GitLab</a>. Start by creating an account. Then go
to
<a href="https://gitlab.gnome.org/GNOME/pitivi">gitlab.gnome.org/GNOME/pitivi</a>
and press the "fork" button. <em>Make sure to be authenticated otherwise
the button won't be available.</em></p>
<p>To be able to push seamlessly to your remote fork, <a href="https://gitlab.gnome.org/profile/keys">add your public ssh
key to GitLab</a>.</p>
<p>Add the remote git repository you just forked as a "remote" to your
local git repository:</p>
<pre><code>$ git remote add your_gitlab_username [email protected]:your_gitlab_username/pitivi.git
$ git fetch your_gitlab_username
</code></pre>
<p>To make a merge request, first push your branch to your fork:</p>
<pre><code>$ git push your_gitlab_username your_branch_name
[...]
remote:
remote: To create a merge request for docs, visit:
remote: https://gitlab.gnome.org/your_gitlab_username/pitivi/merge_requests/new?merge_request%5Bsource_branch%5D=your_branch_name
remote:
[...]
</code></pre>
<p>Open the displayed URL in the browser and fill the form for creating a
merge request. Alternatively, go to
<a href="https://gitlab.gnome.org/GNOME/pitivi">gitlab.gnome.org/GNOME/pitivi</a>
> Merge Requests > New merge request.</p>
<blockquote>
<p>Note: Make sure to select "Allow commits from members who can merge to
the target branch". This way we'll be able to rebase the branch easily
to be able to merge it in case it's behind origin/master.</p>
</blockquote>
<h3 id="the-code-review-cycle">The code review cycle</h3>
<p>One of the maintainers will review your changes and either merge your
branch, or comment and ask for changes.</p>
<p>The comments made by the reviewer have to be addressed by you:</p>
<ul>
<li>
<p>If you disagree with a comment, reply how it's better differently.</p>
</li>
<li>
<p>If you agree with the requests for changes, implement the changes,
commit them and push your branch.</p>
</li>
</ul>
<p>Mark the addressed comment threads as "resolved", unless there is a
disagreement. Finally, inform the reviewer when you are done!</p>
<p>Everybody can see the merge request and comment on it. If you see an
interesting merge request, feel free to review it yourself.</p>
<h4 id="tips-for-creating-the-commits">Tips for creating the commits</h4>
<p>Run <code>gitk main_file_you_changed.py</code> to see how the commit messages
are formatted and try to follow the model.</p>
<p>Before pushing, use <code>gitk</code> to have a quick look at your branch and
review your own changes.</p>
<p>Avoid creating separate "update" commits. We don't need the full history
of changes in the commit history. Consider squashing these in one of the
previous commits where it makes sense.</p>
<p>If you add some new logic and a unittest for it, the unittest should be
included in the same commit as the tested logic.</p>
</div>
</div>
<div id="search_results">
<p>The results of the search are</p>
</div>
<div id="footer">
</div>
</div>
<div id="toc-column">
<div class="edit-button">
<a href="https://gitlab.gnome.org/GNOME/pitivi/edit/master/docs/Development_workflow.md" data-hotdoc-role="edit-button">Edit on GitLab</a>
</div>
<div id="toc-wrapper">
<nav id="toc"></nav>
</div>
</div>
</div>
</main>
<script src="assets/js/navbar_offset_scroller.js"></script>
</body>
</html>