KI/contribute.html at main · ptids/KI · GitHub

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
<!DOCTYPE html>
<html lang="en">

<head>
    <title>Contribute - Katorly Lab</title>

    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">

    <!-- CSS -->
    <link rel="stylesheet" href="assets/css/soft-design-system.min.css">
    <link rel="stylesheet" href="assets/css/style.css">

    <!-- JS -->
    <script type="text/javascript" src="assets/js/bootstrap.bundle.min.js"></script>
    <script type="text/javascript" src="assets/js/soft-design-system.min.js"></script>
    <script type="text/javascript" src="assets/js/jquery.min.js"></script>
    <script type="text/javascript" src="assets/js/script.js"></script>

    <!-- CACHE -->
    <meta http-equiv="Cache-Control" content="max-age=86400 must-revalidate" />
    <meta http-equiv="Pragma" content="no-cache" />
    <meta http-equiv="Expires" content="0" />

    <!-- Google Analytics -->
    <script async src="https://www.googletagmanager.com/gtag/js?id=G-Z2Q2Z42WL2"></script>
    <script>
        window.dataLayer = window.dataLayer || [];
        function gtag() { dataLayer.push(arguments); }
        gtag('js', new Date());

        gtag('config', 'G-Z2Q2Z42WL2');
    </script>

    <!-- FONTS -->
    <link rel="preconnect" href="https://fonts.googleapis.com">
    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
    <link href="https://fonts.googleapis.com/css2?family=Kumbh+Sans:wght@300&display=swap" rel="stylesheet">
    <link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro&display=swap" rel="stylesheet">
    <style>
        .kl-context {
            font-family: 'Source Sans Pro', sans-serif;
        }
    </style>

    <!-- FAVICON -->
    <link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png">
    <link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png">
    <link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png">
    <link rel="mask-icon" href="/safari-pinned-tab.svg" color="#5bbad5">
    <meta name="msapplication-TileColor" content="#da532c">
    <meta name="theme-color" content="#ffffff">
</head>

<body>
    <div class="loader"></div>
    <div class="content">
        <!-- Header -->
        <div id="header"></div>

        <!-- Intro -->
        <div id="intro" class="kl-bg text-light p-5 mb-4" style="background-image:url(img/involving/contribute.jpg)">
            <div class="container-fluid col-xxl-11 py-3">
                <p class="col-md-8 text-sm pb-2"><a href="/involving.html" class="link-secondary">Get involved</a> /
                    Contribute</p>
                <h1 class="display-5 fw-bold text-light">Make Contributions</h1>
                <p class="lead">Read this guide before contributing to Katorly Lab projects.</p>
            </div>
        </div>
        <!-- /Intro -->

        <!-- Article -->
        <div class="container col-xxl-8 px-4 pt-2 pb-5">
            <div class="row flex-lg-row align-items-center g-5 py-5">
                <div class="col-lg-12 kl-context">
                    <p class="text-dark lead mb-0 px-3 pb-2">
                        Katorly Lab welcomes everyone who is warm-hearted to contribute to any of its repositories.
                    </p>
                    <p class="text-dark lead mb-0 px-3 pt-2 pb-4">
                        Make sure you've read the Contributing Guideline before you open an issue or a pull request.
                    </p>
                    <h2 class="fw-bold lh-1 mb-3 pt-5 pb-4">Contributing Guideline</h2>
                    <h3 id="issues" class="fw-bold lh-1 mb-3 px-2 py-2">Issues</h3>
                    <p class="text-dark lead mb-0 px-3 py-4">
                        Issues are usually used to:
                    </p>
                    <ul class="text-muted ms-2 lead">
                        <li>Report bugs</li>
                        <li>Make suggestions</li>
                        <li>Other behaviours that are <strong>related to</strong> the project</li>
                    </ul>
                    <p class="text-dark lead mb-0 px-3 py-2">
                        It is suggested that you should confirm for a several times before opening a new issue, for that
                        sometimes things might go right after a short while.
                    </p>
                    <p class="text-dark lead mb-0 px-3 pt-2 pb-4">
                        Don't be shy to open a new issue, and we won't be angry if we receive invalid ones (but you may
                        not receive help from opening an invalid issue).
                    </p>
                    <div class="alert" role="alert" style="color: #354868; background-color: #F0F0F0;">
                        <span class="alert-icon"><img width="20" height="20" src="/img/protip.svg"></span>
                        <span class="alert-text ms-1">To seek help, go to our <a
                                class="link-dark text-decoration-underline" target="_blank"
                                href="https://github.com/katorlys/HelpCenter/discussions">HelpCenter</a> and
                            open a new
                            discussion, and <strong>do not</strong> open an issue.</span>
                    </div>
                    <h5 id="bugs" class="fw-bold lh-1 mb-3 px-3 pt-4">Report Bugs</h5>
                    <p class="text-dark lead mb-0 px-3 pt-2 py-4">
                        To report a bug, you need to follow the format below:
                    </p>
                    <div class="alert" role="alert" style="background-color: #F0F0F0;">
                        <copybutton>
                            <button id="copybutton" type="button" class="btn bg-white btn-icon-only w-auto shadow-none"
                                style="position: absolute; top: 20px; right: 20px;">
                                <img width="16px" height="auto" class="pb-1" src="/img/involving/copy.svg">
                            </button>
                            <textarea rows="23" class="form-control" wrap="off" readonly="readonly"
                                style="box-shadow: 1px 1px 1px #F0F0F0 ; border-color: #F0F0F0; background-color: #F0F0F0">
### Bug Information
**Describe the bug**
<!-- Make a clear and concise description of what the bug is. Insert screenshots or recorded videos if neccessary.
You may paste compile errors or console errors you've encountered here (if there is any). Make sure to copy the entire error.
If you are willing to use a paste site, please use something like https://gist.github.com or https://pastebin.com. -->

**Operating environment**
- Operating system and its version:
- Programming language and its version:
- Dependencies and their versions: <!-- Type "none" if there isn't any. -->

**Steps to Reproduce**
<!-- Tell us how to reproduce this issue: -->
1.

**Expected behavior**
<!-- Tell us what should happen. -->

**Actual behavior**
<!-- Tell us what happens instead. -->

**Other**
<!-- Have anything else to add? --></textarea>
                        </copybutton>
                    </div>
                    <p class="text-dark lead mb-0 px-3 pt-2 py-4">
                        And please make sure you are using the <strong>latest</strong> version of the project.
                    </p>
                    <div class="alert" role="alert" style="color: #354868; background-color: #F0F0F0;">
                        <span class="alert-icon"><img width="20" height="20" src="/img/protip.svg"></span>
                        <span class="alert-text ms-1">Your issue may be labeled as invalid and closed by the author. If
                            you
                            believe there is an error, please <strong>open a new issue</strong> instead.</span>
                    </div>
                    <h5 id="suggest" class="fw-bold lh-1 mb-3 px-3 pt-4">Make suggestions</h5>
                    <p class="text-dark lead mb-0 px-3 pt-2 py-4">
                        To make a suggestion, you need to follow the format below:
                    </p>
                    <div class="alert" role="alert" style="background-color: #F0F0F0;">
                        <copybutton>
                            <button id="copybutton" type="button" class="btn bg-white btn-icon-only w-auto shadow-none"
                                style="position: absolute; top: 20px; right: 20px;">
                                <img width="16px" height="auto" class="pb-1" src="/img/involving/copy.svg">
                            </button>
                            <textarea rows="10" class="form-control" wrap="off" readonly="readonly"
                                style="box-shadow: 1px 1px 1px #F0F0F0 ; border-color: #F0F0F0; background-color: #F0F0F0">
### Suggestion Information
**Suggestion**
<!-- Enter your suggestion here. Try to be as thorough as possible.
You can also help us improve by pulling a request which correct or improve some of the codes in the corresponding repository. -->

**Reason**
<!-- Tell us why you are suggesting this. -->

**Other**
<!-- Have anything else to add? --></textarea>
                        </copybutton>
                    </div>
                    <p class="text-dark lead mb-0 px-3 pt-2 py-4">
                        Please don't make any feature suggestions that already exist. Search before you make a
                        suggestion in
                        order to prevent duplication.
                    </p>
                    <h3 id="pulls" class="fw-bold lh-1 mb-3 px-2 pt-4 pb-2">Pull Requests</h3>
                    <p class="text-dark lead mb-0 px-3 py-4">
                        Pull requests are used to:
                    </p>
                    <ul class="text-muted ms-2 lead">
                        <li>Contribute code</li>
                        <li>Localizing contents</li>
                        <li>Other contributions that are <strong>related to</strong> the project</li>
                    </ul>
                    <p class="text-dark lead mb-0 px-3 pt-2 py-4">
                        To report a bug, you need to follow the format below:
                    </p>
                    <div class="alert" role="alert" style="background-color: #F0F0F0;">
                        <copybutton>
                            <button id="copybutton" type="button" class="btn bg-white btn-icon-only w-auto shadow-none"
                                style="position: absolute; top: 20px; right: 20px;">
                                <img width="16px" height="auto" class="pb-1" src="/img/involving/copy.svg">
                            </button>
                            <textarea rows="9" class="form-control" wrap="off" readonly="readonly"
                                style="box-shadow: 1px 1px 1px #F0F0F0 ; border-color: #F0F0F0; background-color: #F0F0F0">
### Pull Request Information
<!-- Introduce your pull request here. Make it clear and concise! -->

**Reason**
<!-- Tell us why you are submitting this.
You may paste the link of related issues here if there is any. -->

**Other**
<!-- Have anything else to add? --></textarea>
                        </copybutton>
                    </div>
                    <p class="text-dark lead mb-0 px-3 pt-2 py-4">
                        Remember that formatting contents <strong>will not</strong> be accepted.
                    </p>
                </div>
            </div>
        </div>
        <!-- /Article -->

        <!-- Contents -->
        <div class="btn-group dropstart position-fixed bottom-5 end-5" style="z-index: 99;">
            <button type="button" class="btn bg-white btn-icon-only" data-bs-toggle="dropdown" aria-expanded="false">
                <img width="16" height="auto" src="/img/involving/list.svg">
            </button>
            <ul class="dropdown-menu border shadow-none px-2 py-3">
                <li><a class="dropdown-item border-radius-md" href="#issues">Issues</a></li>
                <ul style="list-style-type: none">
                    <li><a class="dropdown-item border-radius-md" href="#bugs">Report Bugs</a></li>
                    <li><a class="dropdown-item border-radius-md" href="#suggest">Make suggestions</a></li>
                </ul>
                <li><a class="dropdown-item border-radius-md" href="#pulls">Pull Requests</a></li>
                <li>
                    <hr class="dropdown-divider">
                </li>
                <li><a class="dropdown-item border-radius-md" target="_blank"
                        href="https://github.com/katorlys/katorlys.github.io/blob/main/contribute.html">
                        <img width="16px" height="auto" class="me-1 pb-1" src="/img/involving/edit.svg">Improve</a>
                </li>
                <li><a class="dropdown-item border-radius-md" href="javascript:scroll(0,0)">
                        <img width="20px" height="auto" class="pb-1" src="/img/up.svg">Back to Top</a>
                </li>
            </ul>
        </div>
        <!-- /Contents -->

        <!-- Footer -->
        <div id="footer"></div>

        <!-- INCLUDES -->
        <script type="text/javascript">
            $("#header").load("assets/components/nav.html #header");
            $("#footer").load("assets/components/nav.html #footer");

            $("copybutton").click(function () {
                $(this).children("textarea").select();
                document.execCommand('copy');
                $(this).children("button").children("img").attr("src", "/img/involving/copied.svg");
                $this = $(this);
                setTimeout("$this.children('button').children('img').attr('src', '/img/involving/copy.svg');", 1000);
            });
        </script>
    </div>
</body>

</html>