-
Notifications
You must be signed in to change notification settings - Fork 17
/
Copy pathcontribute.html
120 lines (120 loc) · 7.04 KB
/
contribute.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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>How to contribute</title>
<link href="https://fonts.googleapis.com/css2?family=Paytone+One&display=swap" rel="stylesheet">
<link rel="stylesheet" href="./styles.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.8.4/themes/prism.min.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.8.4/prism.min.js"></script>
</head>
<body>
<header>
<div class="banner flex direction-column align-items-center">
<h1 class="title">
The <span class="purple">.NET</span> Bot Exhibition
</h1>
<div class="add-bot flex align-items-center">
<h1 class="center">HOW TO CONTRIBUTE</h1>
</div>
</div>
</header>
<main class="container">
<p>
You need a GitHub Account to contribute. If you don't have one, don't worry, it's very easy. Just go to <a href="https://github.com/join" target="_new">this page</a>.
</p>
<p>
We also ask you to agree with our <a href="https://github.com/tagazok/the-dotnetbot-exhibition/blob/main/coc.md">code of conduct</a>.
</p>
<P>
You are now ready to make your first pull request ! Now, there is two ways : <a href="#easy-way">the easy way</a>, and <a href="#developer-way">the developer way</a>. Choose the one you are the most confortable with
</P>
<h3 id="easy-way">The easy way</h3>
<p>
<ol>
<li>Go to <a href="https://mod-dotnet-bot.net/create-your-bot" target="_new">https://mod-dotnet-bot.net</a> and create your own .NET Bot.</li>
<li>Export it to an image (use the share and then download buttons).</li>
<li>Rename the image file with your GitHub username (ex: <span class="code">your-username.png</span>).</li>
<li>Go to <a href="https://github.com/tagazok/the-dotnetbot-exhibition" target="_blank">this GitHub repository</a>.</li>
<li>Fork the repository by clicking the "fork" button on the top right.</li>
<li>Upload and commit your image in the "bots" folder
<ul>
<li>Navigate to the <span class="code">Code</span> tab</li>
<li>Go into the <span class="code">bots</span> folder</li>
<li>Click on <span class="code">Add file</span> button</li>
<li>Drag & Drop your file in the designated area</li>
<li>Add a <span class="code">commit changes</span> message</li>
<li>Click on <span class="code">Commit changes</span> (make sure the image is fully uploaded before)</li>
</ul>
</li>
<li>Add and commit your GitHub username and message in the <span class="code">contributors.json</span> file</li>
<ul>
<li>Navigate to the <span class="code">Code</span> tab</li>
<li>Open the <span class="code">contributors.json</span> file</li>
<li>Click on the 🖉 icon. This should open a text editor</li>
<li>Add a line with your username and a short message before the others
<p>
<code class="language-json">
{ "username": "your-username", "message": "Say something kind or fun" },
</code>
</p>
</li>
<li>Add a <span class="code">commit changes</span> message</li>
<li>Click on <span class="code">Commit changes</span></li>
</ul>
<li>Create the Pull Request 🎉
<ul>
<li>Navigate to the <span class="code">Code</span> tab</li>
<li>Just above the folders & files list, you should have a <span class="code">Pull request</span> button. Click on it</li>
<li>Click on the <span class="code">Create pull request</span> button</li>
<li>Enter a title</li>
<li>Make sure your pull request checks all the conditions</li>
<li>Click on the <span class="code">Create pull request</span> button</li>
</ul>
</li>
</ol>
<div class="flex direction-column align-items-center">
<div>Your PR is done !</div>
<div>
<p>
You can go back to the <a href="./index.html">home page</a> to view your bot
</p>
</div>
</div>
</p>
<h3 id="developer-way">The developer way</h3>
<p>
<ol>
<li>Go to <a href="https://mod-dotnet-bot.net/create-your-bot" target="_new">https://mod-dotnet-bot.net</a> and create your own .NET Bot</li>
<li>Export it to an image (use the share and then download buttons)</li>
<li>Go to <a href="https://github.com/tagazok/the-dotnetbot-exhibition" target="_blank">this GitHub repository</a></li>
<li>Fork the repository and clone it</li>
<li>Rename the image file with your GitHub username (ex: <span class="code">your-username.png</span>)</li>
<li>Add your image in the <span class="code">bots/ folder</span></li>
<li>In the <span class="code">contributor.json</span> file, add a line with your GitHub username and a short message</li>
<p>
<code class="language-json">
{ "username": "your-username", "message": "Say something kind or fun" },
</code>
</p>
</li>
<li>Commit and push your modification</li>
<li>Make sure your pull request checks all the conditions</li>
<li>Create a PR</li>
</ol>
</p>
<h3>Your PR must respect the following conditions:</h3>
<ol>
<li>Your contribution must respect the <a href="https://github.com/tagazok/the-dotnetbot-exhibition/blob/main/coc.md">code of conduct</a>.</li>
<li>It's your first PR to this repository.</li>
<li>You have added your image of the dot downloaded from <a href="https://mod-dotnet-bot.net">https://mod-dotnet-bot.net</a>.</li>
<li>You have not changed the image.</li>
<li>The image filename must be your GitHub username (ex: your-username.png).</li>
<li>You are using your own GitHub account and it's the same as the PR author.</li>
<li>Into the contributors.json file, the message must be short and respect the code of conduct.</li>
</ol>
</main>
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.8.4/components/prism-json.min.js"></script>
</body>
</html>