forked from cypht-org/cypht-website
-
Notifications
You must be signed in to change notification settings - Fork 0
/
contribute.html
130 lines (125 loc) · 6.44 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
121
122
123
124
125
126
127
128
129
130
<!DOCTYPE html>
<html class="no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Contribute</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" type="image/png" href="img/icon.ico">
<link rel="stylesheet" href="site.css">
</head>
<body>
<header>
<nav class="navbar navbar-expand-lg navbar-dark fixed-top">
<div class="container">
<a class="navbar-brand" href="index.html">
<img src="img/logo.svg" width="120" height="60" alt="">
</a>
<button class="navbar-toggler toggler-home" type="button" data-toggle="collapse"
data-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false"
aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse navbar-collapse " id="navbarSupportedContent">
<ul class="navbar-nav ml-lg-auto">
<li class="nav-item">
<a class="nav-link" href="index.html">Home <span class="sr-only">(current)</span>
</a>
</li>
<li class="nav-item">
<a class="nav-link" href="features.html">Features</a>
</li>
<li class="nav-item">
<a class="nav-link" href="security.html">Security</a>
</li>
<li class="nav-item">
<a class="nav-link" href="modules.html">Mods</a>
</li>
<li class="nav-item">
<a class="nav-link" href="license.html">License</a>
</li>
<li class="nav-item">
<!--<a class="nav-link" href="tests.html">Test</a>-->
</li>
<li class="nav-item">
<a class="nav-link" href="documentation.html">Documentation</a>
</li>
<li class="nav-item">
<a class="nav-link" href="https://unencumberedbyfacts.com" target="_blank">Blog</a>
</li>
<li class="nav-item active">
<a onclick="document.getElementsByClassName('navbar-collapse')[0].style.display='none';"
class="nav-link" href="contribute.html">Contribute</a>
</li>
</ul>
</div>
</div>
</nav>
</header>
<section class="contibute-section container">
<div class="container">
<h2 id="contributing">Want to contribute?</h2>
<p>First of all, thank you for interest to cypht! The goal of this page is to provide everything you need to know in order to contribute to cypht-website and its different integrations.</p>
<ul>
<li><a href="#development-workflow">Development Workflow</a></li>
<li><a href="#requirements">Requirements</a></li>
<li><a href="#git-guidelines">Git Guidelines</a></li>
</ul>
<h2 id="development-workflow">Development Workflow</h2>
<p>The project, particularly version 1.4.x, has been designed with plain HTML and CSS, focusing on front-end and back-end development without the use of extra features or frameworks.</p>
<p>However, it's worth noting that in version 2.1.x, while there's no PHP back-end framework utilized for its back-end, Bootstrap is adopted as the front-end framework, enhancing the project's user interface and experience.</p>
<h2 id="requirements">Requirements</h2>
<ol>
<li>You're familiar with <a href="https://github.com">GitHub</a> and the
<a href="https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests">Pull Request</a> (PR) workflow.
</li>
<li>You've read the Cypht <a href="documentation.html">documentation</a> and the <a
href="https://github.com/cypht-org/cypht#readme">README</a>.
</li>
<li>You know about the <a href="https://gitter.im/cypht-org/community">Cypht community.</a> Please use this as help.
</li>
</ol>
<h2 id="git-guidelines">Git Guidelines</h2>
<ol>
<li>Make sure that the contribution you want to make is explained or detailed in a GitHub issue! Find an
<a href="https://github.com/cypht-org/cypht-website/issues">existing issue</a> or
<a href="https://github.com/cypht-org/cypht-website/issues/new/choose">open a new one</a>.
</li>
<li>Once done,
<a href="https://github.com/cypht-org/cypht-website/fork">fork the cypht website repository</a> to your own GitHub account.
You can request a maintainer to check your issue before making a PR.
</li>
<li>Create a new Git branch.</li>
<li>Review the <a href="#development-workflow">Development Workflow</a> section that describes the project's technology used.
</li>
<li>Implement the changes on your branch.</li>
<li>
Submit the branch as a PR pointing to the <code>master</code> branch of cypht-website repository.
A maintainer will comment and/or review your Pull Request. Depending on the circumstances, this process may take some time.<br>
</li>
</ol>
<h2>Have a question? </h2>
<p>We love feedback so let us know what you think! <br> Leave a comment, submit your problem or contribute to
the project <br> by joining the community first.
</p>
<a href="https://github.com/cypht-org/cypht/">
<button type="button" class="btn btn-success">GitHub</button>
</a>
<a href="https://gitter.im/cypht-org/community">
<button type="button" class="btn btn-success">Gitter</button>
</a>
<a href="https://www.openhub.net/p/cypht/users">
<button type="button" class="btn btn-success">OpenHub</button>
</a>
</div>
</section>
<script>
((window.gitter = {}).chat = {}).options = {
room: 'cypht-org/community'
};
</script>
<script src="jquery.slim.min.js"></script>
<script src="bootstrap.bundle.min.js"></script>
</body>
</html>