-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathcontributing.html
382 lines (330 loc) · 27.1 KB
/
contributing.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
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
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
<!DOCTYPE html>
<html lang="en">
<head>
<title>Universal Blue – Contributing</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="theme-color" content="#4051b5" />
<meta name="msapplication-config" content="none">
<!-- Favicon -->
<link rel="icon" href="content/favicon-new.png" type="image/png" sizes="any">
<!--<link rel="icon" href="content/favicon.svg" type="image/svg+xml">-->
<!-- Preconnect -->
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="preconnect" href="https://cdnjs.cloudflare.com">
<link rel="preconnect" href="https://repobeats.axiom.co">
<link rel="preconnect" href="https:///universal-blue.discourse.group">
<!-- CSS -->
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/bootstrap/5.3.3/css/bootstrap.min.css" integrity="sha512-jnSuA4Ss2PkkikSOLtYs8BlYIeeIK1h99ty4YfvRPAlzr377vr3CXDb7sb7eEEBYjDtcYj+AjBH3FLv5uSJuXg==" crossorigin="anonymous" referrerpolicy="no-referrer" />
<link rel="stylesheet" href="css/style5.css">
<link rel="stylesheet" href="css/style-responsive.css">
<link rel="stylesheet" href="css/vertical-rhythm.min.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/OwlCarousel2/2.3.4/assets/owl.carousel.min.css" integrity="sha512-tS3S5qG0BlhnQROyJXvNjeEM4UpMXHrQfTGmbQ1gKmelCxlSEBUaxhRBj/EFTzpbP4RVSrpEikbmdJobCvhE3g==" crossorigin="anonymous" referrerpolicy="no-referrer" />
<link rel="stylesheet" href="css/splitting.css">
<link rel="stylesheet" href="css/YTPlayer.css">
<link rel="stylesheet" href="css/main.css">
<!-- Google Fonts -->
<link href="https://fonts.googleapis.com/css2?family=DM+Sans:wght@400;500;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Red+Hat+Display:wght@300&display=swap" rel="stylesheet">
<!-- Font Awesome -->
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.7.2/css/fontawesome.min.css" integrity="sha512-v8QQ0YQ3H4K6Ic3PJkym91KoeNT5S3PnDKvqnwqFD1oiqIl653crGZplPdU5KKtHjO0QKcQ2aUlQZYjHczkmGw==" crossorigin="anonymous" referrerpolicy="no-referrer" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.7.2/css/solid.min.css" integrity="sha512-DzC7h7+bDlpXPDQsX/0fShhf1dLxXlHuhPBkBo/5wJWRoTU6YL7moeiNoej6q3wh5ti78C57Tu1JwTNlcgHSjg==" crossorigin="anonymous" referrerpolicy="no-referrer" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.7.2/css/brands.min.css" integrity="sha512-58P9Hy7II0YeXLv+iFiLCv1rtLW47xmiRpC1oFafeKNShp8V5bKV/ciVtYqbk2YfxXQMt58DjNfkXFOn62xE+g==" crossorigin="anonymous" referrerpolicy="no-referrer" />
</head>
<body class="appear-animate simple-page">
<!-- Page Loader -->
<div class="page-loader">
<div class="loader">Loading...</div>
</div>
<!-- End Page Loader -->
<!-- Skip to Content -->
<a href="#main" class="btn skip-to-content">Skip to Content</a>
<!-- End Skip to Content -->
<!-- Page Wrap -->
<div class="page" id="top">
<!-- Navigation Panel -->
<nav class="main-nav transparent stick-fixed wow-menubar wch-unset">
<div class="main-nav-sub full-wrapper">
<!-- Logo -->
<div class="nav-logo-wrap local-scroll">
<a href="https://universal-blue.org/" class="logo">
<img src="content/ublue-header-white.svg" alt="Universal Blue" width="2732" height="692" />
</a>
</div>
<!-- Mobile Menu Button -->
<div class="mobile-nav" role="button" tabindex="0">
<i class="mobile-nav-icon"></i>
<span class="visually-hidden">Menu</span>
</div>
<!-- Main Menu -->
<div class="inner-nav desktop-nav">
<ul class="clearlist scroll-nav local-scroll">
<li><a href="https://universal-blue.org">Return Home</a></li>
</ul>
</div>
<!-- End Main Menu -->
</div>
</nav>
<!-- End Navigation Panel -->
<main id="main">
<!-- Content Section -->
<section class="page-section" id="content">
<div class="container position-relative">
<div class="row mb-60 mb-xs-30">
<div class="col-12">
<h3 class="section-title mb-0"><span class="wow charsAnimIn" data-splitting="chars">Welcome to Universal Blue</span></h3>
</div>
</div>
<div class="row wow fadeInUp" data-wow-delay="0.25s">
<p>Thanks for taking the time to look into helping out!
All contributions are appreciated!
Please refer to our <a href="code-of-conduct.html">Code of Conduct</a> while you're at it!
</p>
<p>Feel free to report issues as you find them, and <a href="">helping others in the discussions</a> is always appreciated.</p>
<h1 id="contributing">Contributing</h1>
<p>All types of contributions are encouraged and valued. See the <a href="#table-of-contents">Table of Contents</a> for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. </p>
<blockquote>
<p>And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:</p>
<ul>
<li>Star the project</li>
<li>Tweet about it</li>
<li>Refer this project in your project's readme</li>
<li>Mention the project at local meetups and tell your friends/colleagues</li>
</ul>
</blockquote>
<h2 id="table-of-contents">Table of Contents</h2>
<ul>
<li><a href="#code-of-conduct">Code of Conduct</a></li>
<li><a href="#i-have-a-question">I Have a Question</a></li>
<li><a href="#i-want-to-contribute">I Want To Contribute</a></li>
<li><a href="#reporting-bugs">Reporting Bugs</a></li>
<li><a href="#how-to-test-incoming-changes">How to test incoming changes</a></li>
<li><a href="#building-locally">Building Locally</a></li>
<li><a href="#styleguides">Styleguides</a></li>
<li><a href="#commit-messages">Commit Messages</a></li>
<li><a href="#nvidia">Nvidia</a></li>
<li><a href="#join-the-project-team">Join The Project Team</a></li>
</ul>
<h2 id="code-of-conduct">Code of Conduct</h2>
<p>This project and everyone participating in it is governed by the
<a href="code-of-conduct.html">CONTRIBUTING.md Code of Conduct</a>.
By participating, you are expected to uphold this code. Please report unacceptable behavior
to jorge.castro@gmail.com
</p>
<h2 id="i-have-a-question">I Have a Question</h2>
<blockquote>
<p>If you want to ask a question, ask in the <a href="https://github.com/orgs/ublue-os/discussions">discussion forum</a></p>
</blockquote>
<h2 id="i-want-to-contribute">I Want To Contribute</h2>
<blockquote>
<h3 id="legal-notice">Legal Notice</h3>
<p>When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.</p>
</blockquote>
<p>Generally speaking we try to follow the <a href="http://lazyconcens.us/">Lazy Concensus</a> model of development to keep the builds healthy and ourselves happy. </p>
<ul>
<li>If you're looking for concensus to make a decision post an issue for feedback and remember to account for timezones and weekends/holidays/work time. </li>
<li>We want people to be opinionated in their builds so we're more of a loose confederation of repos than a top-down org.</li>
<li>Try not to merge your own stuff, ask for a review. At some point when we have enough reviewers we'll be turning on branch protection. </li>
</ul>
<h3 id="reporting-bugs">Reporting Bugs</h3>
<h4 id="before-submitting-a-bug-report">Before Submitting a Bug Report</h4>
<p>A good bug report should describe the issue in detail. Generally speaking:</p>
<ul>
<li>Make sure that you are using the latest version.</li>
<li>Remember that these are unofficial builds, it's usually prudent to investigate an issue before reporting it here or in Fedora!</li>
<li>
Collect information about the bug:
<ul>
<li><code>rpm-ostree status -v</code> usually helps</li>
</ul>
</li>
<li>Image and Version </li>
<li>Possibly your input and the output</li>
<li>Can you reliably reproduce the issue? And can you also reproduce it with older versions?</li>
</ul>
<h3 id="how-to-test-incoming-changes">How to test incoming changes</h3>
<p>One of the nice things about the image model is that we can generate an entire OS image for every change we want to commit, so this makes testing way easier than in the past. You can rebase to it, see if it works, and then move back. This also means we can increase the amount of testers! </p>
<p>We strive towards a model where proposed changes are more thoroughly reviewed and tested by the community. So here's how to do it. If you see a pull request that is opened up on an image you're following you can leave a review on how it's working for you. At the bottom of every PR you'll see something like this: </p>
<p><img src="https://user-images.githubusercontent.com/1264109/221305388-3860fc07-212c-4eb9-80d9-5d7a35a77f46.png" alt="image"></p>
<p>Click on "Add your review", and then you'll see this: </p>
<p><img src="https://user-images.githubusercontent.com/1264109/221307636-5e312e48-821f-4206-848f-7fbc2c91cd78.png" alt="image"></p>
<p>Don't worry, you can't mess anything up, all the merging and stuff will be done by the maintainer, what this does is lets us gather information in a more formal manner than just shoving everything in a forum thread. The more people are reviewing and testing images, the better off we'll be, especially for images that are new like Sericea.</p>
<p>At some point we'll have a bot that will leave you instructions on how to rebase to the image and all that stuff, but in the meantime we'll leave instructions manually. </p>
<p>Here's an example: <a href="https://github.com/ublue-os/nvidia/pull/49">https://github.com/ublue-os/nvidia/pull/49</a></p>
<h2 id="building-locally">Building Locally</h2>
<p>The minimum tools required are git and a working machine with podman enabled and configured.
Building locally is much faster than building in GitHub and is a good way to move fast before pushing to a remote.
</p>
<h3 id="clone-the-repo-you-want">Clone the repo you want</h3>
<pre><code>git <span class="hljs-keyword">clone</span> <span class="hljs-title">https</span>://github.com/ublue-os/base.git
</code></pre>
<h3 id="build-the-image">Build the image</h3>
<p>First make sure you can build an existing image: </p>
<pre><code><span class="hljs-symbol">podman</span> <span class="hljs-keyword">build </span>. -t something
</code></pre>
<p>Then confirm your image built:</p>
<pre><code>podman <span class="hljs-keyword">image</span> <span class="hljs-keyword">ls</span>
</code></pre>
<p>TODO: Set up and push to your own local registry</p>
<h3 id="make-your-changes">Make your changes</h3>
<p>This usually involved editing the <code>Containerfile</code>. Most techniques for building containers apply here, if you're new to containers using the term "Dockerfile" in your searches usually shows more results when you're searching for information. </p>
<p>Check out CoreOS's <a href="https://github.com/coreos/layering-examples">layering examples</a> for more information on customizing. </p>
<h3 id="reporting-problems-to-fedora">Reporting problems to Fedora</h3>
<p>We endevaour to be a good partner for Fedora.</p>
<p>This project is consuming new features in Fedora and ostree, it is not uncommon to find an issue.
Issues should be reported upstream, and in some cases we can help test and find fixes.
Some of the issues you find may involve other dependencies in other projects, in those cases the Fedora team will tell you where to report the issue.
</p>
<p>Upstream bug tracker: <a href="https://github.com/fedora-silverblue/issue-tracker/issues">https://github.com/fedora-silverblue/issue-tracker/issues</a></p>
<h2 id="styleguides">Styleguides</h2>
<h3 id="commit-messages">Commit Messages</h3>
<p>We use <a href="https://www.conventionalcommits.org/en/v1.0.0/">Conventional Commits</a> and enforce them with a bot to keep the changelogs tidy:</p>
<pre><code><span class="hljs-symbol">chore:</span> <span class="hljs-keyword">add</span> Oyster build script
<span class="hljs-symbol">docs:</span> explain hat wobble
<span class="hljs-symbol">feat:</span> <span class="hljs-keyword">add</span> beta sequence
<span class="hljs-symbol">fix:</span> remove broken confirmation message
<span class="hljs-symbol">refactor:</span> share logic between <span class="hljs-number">4</span>d3d3d3 <span class="hljs-keyword">and</span> flarhgunnstow
<span class="hljs-symbol">style:</span> convert tabs to spaces
<span class="hljs-symbol">test:</span> ensure Tayne retains clothing
</code></pre>
<h2 id="nvidia">Nvidia</h2>
<p>Please note, RPM Fusion supports the initial Nvidia driver release available with each Fedora version as well as the latest version. Any intermittent versions are not maintained by RPM Fusion after they have been superceded with a new version.</p>
<p>Keep in mind checks, other than building the akmods, do fail in pull requests.</p>
<h2 id="join-the-project-team">Join The Project Team</h2>
<p>If you're interested in <em>maintaining</em> something then let us know!</p>
<h2 id="attribution">Attribution</h2>
<p>This guide is based on the <strong>contributing.md</strong>. <a href="https://contributing.md/">Make your own</a>!</p>
</div>
</div>
</section>
<!-- End Content Section -->
</main>
<!-- Footer -->
<footer class="page-section footer bg-gray-light-1 pb-30">
<div class="container">
<div class="row pb-120 pb-sm-80 pb-xs-50">
<div style="text-align:center;" class="col-md-4 col-lg-3 text-gray mb-sm-50">
<div class="mb-10 footer-logo">
<img src="content/ublue-mini.svg" width="100" height="100" alt="Universal Blue" />
</div>
<p>
Your community toolkit designed to reboot the Linux desktop. Built for the love of the game. Welcome to indie Cloud Native.
</p>
</div>
<div class="col-md-7 offset-md-1 offset-lg-2">
<div class="row mt-n30">
<!-- Footer Widget -->
<!--<div class="col-sm-4 mt-80">
</div>-->
<!-- End Footer Widget -->
<!-- Footer Widget -->
<div class="col-sm-6 mt-80">
<h3 class="fw-title">Documentation</h3>
<ul class="fw-menu clearlist">
<li>
<a href="documentation.html">
Images
</a>
</li>
<li>
<a href="mission.html">
Mission
</a>
</li>
<li>
<a href="values.html">
Values
</a>
</li>
<li>
<a href="membership.html">
Membership
</a>
</li>
<li>
<a href="code-of-conduct.html">
Code of Conduct
</a>
</li>
<li>
<a href="contributing.html">
Contributing
</a>
</li>
</ul>
</div>
<!-- End Footer Widget -->
<!-- Footer Widget -->
<div class="col-sm-6 mt-80">
<h3 class="fw-title">Social Media</h3>
<ul class="fw-menu clearlist">
<li>
<a href="https://universal-blue.discourse.group/" rel="noopener nofollow" target="_blank">
<i class="fa-brands fa-discourse"></i>
Discourse
</a>
</li>
<li>
<a href="https://fosstodon.org/@UniversalBlue" rel="noopener nofollow" target="_blank">
<i class="fa-brands fa-mastodon"></i>
Mastodon
</a>
</li>
<li>
<a href="https://www.youtube.com/c/JorgeCastro/videos" rel="noopener nofollow" target="_blank">
<i class="fa-brands fa-youtube"></i>
Youtube
</a>
</li>
<li>
<a href="https://discord.gg/WEu6BdFEtp" rel="noopener nofollow" target="_blank">
<i class="fa-brands fa-discord"></i>
Discord
</a>
</li>
<li>
<a href="https://www.answeroverflow.com/c/1072614816579063828" rel="noopener nofollow" target="_blank">
<i class="fa-solid fa-comment"></i>
Answer Overflow
</a>
</li>
</ul>
</div>
<!-- End Footer Widget -->
</div>
</div>
</div>
<!-- Footer Text -->
<div class="row text-gray">
<div class="col-md-4 col-lg-3">
<b>© Universal Blue <span id="current-year">2024</span></b>
</div>
<div class="col-md-7 offset-md-1 offset-lg-2 clearfix">
<span style="font-size:12px;">Universal Blue is not affiliated with Red Hat or the Fedora Project.</span>
<!-- Back to Top Link -->
<div class="local-scroll float-end mt-n20 mt-sm-10">
<a href="#top" class="link-to-top">
<i class="mi-arrow-up size-24"></i>
<span class="visually-hidden">Scroll to top</span>
</a>
</div>
<!-- End Back to Top Link -->
</div>
</div>
<!-- End Footer Text -->
</div>
</footer>
<!-- End Footer -->
</div>
<!-- End Page Wrap -->
<!-- JS -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.7.1/jquery.min.js" integrity="sha512-v2CJ7UaYy4JwqLDIrZUI/4hqeoQieOmAZNXBeQyjo21dadnwR+8ZaIJVT8EE2iyI61OV8e6M8PP2/4hpQINQ/g==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/bootstrap/5.3.3/js/bootstrap.bundle.min.js" integrity="sha512-7Pi/otdlbbCR+LnW+F7PwFcSDJOuUJB3OxtEHbg4vSMvzvJjde4Po1v4BR9Gdc9aXNUNFVUY+SK51wWT8WF0Gg==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/OwlCarousel2/2.3.4/owl.carousel.min.js" integrity="sha512-bPs7Ae6pVvhOSiIcyUClR7/q2OAsRiovw4vAkX+zJbw3ShAeeqezq50RIIcIURq7Oa20rW2n2q+fyXBNcU9lrw==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
<script src="js/plugins.js"></script>
<script src="js/all.js"></script>
<script type="text/javascript" src="https:///universal-blue.discourse.group/javascripts/embed-topics.js"></script>
<!-- End JS -->
</body>
</html>