-
Notifications
You must be signed in to change notification settings - Fork 0
/
contributing.html
108 lines (92 loc) · 5.24 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
<!DOCTYPE html>
<html lang="en" class="without-js">
<head>
<title>Contributing to Jovian NixOS | Jovian-NixOS</title>
<base href="." />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, minimum-scale=1.0, initial-scale=1.0" />
<link rel="stylesheet" href="styles/index.css" type="text/css" />
<script>
var html = document.documentElement;
html.className = html.className.replace("without-js", "with-js");
</script>
</head>
<body class="path--contributing-html">
<header>
<div>
<h1><a href="index.html">Jovian-NixOS</a></h1>
<nav>
<ul>
<li><a href="getting-started.html" class="-getting-started">Getting Started</a></li>
<li><a href="in-depth.html" class="-in-depth">In Depth</a></li>
<li><a href="options.html" class="-options">Options</a></li>
<li><a href="packages.html" class="-packages">Packages</a></li>
<li><a href="contributing.html" class="-contributing">Contributing</a></li>
<li><a href="search.html" class="-search">Search</a></li>
</ul>
</nav>
</div>
</header>
<main>
<div class="generic-layout">
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<html><body>
<h1>Contributing to Jovian NixOS</h1>
<p>Development happens on the <a href="https://github.com/Jovian-Experiments/Jovian-NixOS/">GitHub Repository</a>.</p>
<h2>Reporting issues</h2>
<p>Yes, issues are contributions.</p>
<p>First, look around <a href="https://github.com/Jovian-Experiments/Jovian-NixOS/issues?q=is%3Aissue+">in the opened and closed issues</a>, someone might have reported the same issue.
In case of doubt or if it's not the same exact issue, feel free to <a href="https://github.com/Jovian-Experiments/Jovian-NixOS/issues/new">open a new issue</a>.</p>
<p>If you're not sure an issue is the same or not, especially an older closed issue, prefer opening a new issue, and in the issue tell us you suspect it could be related to that other issue.</p>
<p>First, identify if the issue not an upstream NixOS issue.
If it is not related to a device-specific issue (e.g. Steam Deck), to the Steam Deck UI integration, or to the few other system integration this repository handles, it is possibly a NixOS issue.
If you're unsure, it's okay to report it in the Jovian NixOS repository, at worst we'll explain how it's unrelated and ask you to report back to upstream and cross-reference.</p>
<h2>Submitting changes</h2>
<p>Opening <a href="https://github.com/NixOS/nixpkgs/pulls">a Pull Request on the GitHub repository</a> is the preferred contribution workflow.</p>
<p>Though, if you can't, or don't want to, a properly <code>git format-patch</code> or <code>git send-email</code> contribution is fine too.
Find one or a few major contributor's e-mail address in the git repo, and send it there.</p>
<p>There are no strict guidelines.</p>
<ul>
<li>Changes that are not about hardware-specific quirks, the Steam Deck UI, or system integration thereof should preferably be sent to Nixpkgs.</li>
<li>Implement as if you were contributing to Nixpkgs.</li>
<li>Test your changes, and tell us what you did do, and what you did not do.</li>
</ul>
<h2>“AI”-assisted changes</h2>
<blockquote class="admonition-box -note">
<header>Note</header>
<p>Using pre-existing <strong>boilerplate</strong>, <strong>snippets</strong>, or <strong>syntax suggestions</strong> from your IDE are not considered as “AI”-assisted changes.</p>
</blockquote>
<p>Contributions written largely with help of LLMs (<em>Large Language Models</em>), other “AI” (or non-“AI”), or similar systems are not welcome.
Such systems of concern are generally using statistical models built on “knowledge” acquired for the purpose without express consent, and with disregard of the authorship and attribution.</p>
<p>This includes, but is not limited to:</p>
<ul>
<li>Using them to generate comments</li>
<li>Using them to generate documentation</li>
<li>Using them to generate code</li>
</ul>
<p>Contributions should be largely authored by the people in the commit information, e.g. the <code>Committer,</code> <code>Author</code>, <code>Signed-off-by</code>, and <code>Co-authored-by</code> fields, exclusively.</p>
<p>If you are unsure, or you had help from automated “AI”-generation in <em>part</em> of your contribution, please tell us when contributing.
It does not mean the contribution will be rejected outright.
We will evaluate on a case-by-case basis.
We value honesty, and take it into consideration.</p>
<h2>Other resources</h2>
<ul>
<li><a href="https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md?">The NixOS/Nixpkgs <code>CONTRIBUTING.md</code></a></li>
<li><a href="https://nixos.org/manual/nixpkgs/unstable/">The Nixpkgs manual</a></li>
<li><a href="https://nixos.org/manual/nixos/unstable/">The NixOS manual</a></li>
</ul>
</body></html>
</div>
</main>
<footer>
<div>
<nav>
<ul>
<li><a href="sitemap.html">Sitemap</a></li>
<li><a href="https://github.com/Jovian-Experiments/Jovian-NixOS/edit/development/docs/../CONTRIBUTING.md">Edit this page</a></li>
</ul>
</nav>
</div>
</footer>
</body>
</html>