-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcontributor-guide.html
110 lines (110 loc) · 5.74 KB
/
contributor-guide.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
<!DOCTYPE html>
<html>
<head>
<!-- FONTS, BOOTSTRAP, FONT-AWESOME -->
<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css">
<link href="https://fonts.googleapis.com/css?family=Alegreya" rel="stylesheet">
<script src="https://use.fontawesome.com/7a0beaf8bc.js"></script>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
<!-- <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"></script> -->
<!-- <link rel="stylesheet" type="text/css" href="css/font-awesome.min.css"> -->
<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/normalize/6.0.0/normalize.css">
<link rel="font/ttc" href="Shree714.ttc" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" type="text/css" href="css/styles.css">
<title>Casium Contributor's Guide</title>
</head>
<body>
<header class="header container-fluid cg-header">
<div class="row">
<div class="col-md-4 col-sm-4 col-xs-4 nav-logo">
<a href="index.html" class="link-reset">Casium</a>
</div>
<nav class="col-md-offset-2 col-md-6 col-sm-8 col-xs-8 nav-container">
<div class="hamburger-btn">
<span class="hamburger-btn-open hamburger-btn-show">☰</span>
<span class="hamburger-btn-close">✕</span>
</div>
<ul class="nav">
<li class="nav-item">
<a href="index.html" class="link-reset">Quick Start</a>
</li>
<li class="nav-item" id="docs">
Documentation
<div class="submenu">
<a class="submenu-item link-reset" href="architecture-book/book/index.html">Book</a>
<a class="submenu-item link-reset" href="https://github.com/ai-labs-team/architecture">Github</a>
</div>
</li>
<li class="nav-item">
<a href="#" class="nav-item link-reset">Contribute</a>
</li>
</ul>
</nav>
</div>
</header>
<main class="cg-container container-fluid">
<div class="cg">
<h1 class="cg-heading">
<span class="cg-title">Open Souce Contributor Guide</span>
<span class="cg-ai">Advisor Innovation Labs</span>
</h1>
<p>Thank you for your interest in helping out. AI Labs is committed to building the best possible software and we believe that one of the best ways to do this is to contribute to the development community and (hopefully) benefit from wide peer review. Please feel free to reach out to #EMAIL/WEB# with any questions or submit an issue on Github.</p>
<h2>What do I need to know to help?</h2>
<p>AI Labs uses the following technologies that you should be familiar with:</p>
<ul>
<li class="external-logo-container">
<a class="link-reset" href="http://php.net">
<img src="img/php-logo.png" class="external-logo php-logo" alt="PHP logo" />
<p class="external-logo-text">PHP 5.6</p>
</a>
</li>
<li class="external-logo-container">
<img src="img/es6-logo.png" class="external-logo" alt="ES6 logo" />
<p class="external-logo-text">Javascript</p>
</li>
<li class="external-logo-container">
<a class="link-reset" href="https://github.com/MostlyAdequate/mostly-adequate-guide">
<img src="img/functional-logo.png" class="external-logo" alt="functional programming logo"/>
<p class="external-logo-text">Functional Programming</p>
</a>
</li>
<li class="external-logo-container">
<a class="link-reset" href="http://ramdajs.com/docs/">
<img src="img/ramda.png" class="external-logo" alt="Ramda logo" />
<p class="external-logo-text">Ramda</p>
</a>
</li>
</ul>
<p>How can I chip in?</p>
<ol>
<li>Find an issue that you are interested in addressing by going to the GitHub Issues pages at Architecture and Architecture-devtools. </li>
<li>Fork the repository to your local GitHub organization so it lives at your-GitHub-username/repository-name.</li>
<li>Clone the repository to your local machine.</li>
<li>Create a new branch for your contribution.</li>
<li>Make appropriate changes.</li>
<li>Commit your changes with a short but descriptive message.</li>
<li>Push the changes to the remote repository using git push origin branch-name-here.</li>
<li>Submit a pull request to the upstream repository.</li>
<li>Title the pull request with a short description including the issue number if applicable. Eg. "Added more log outputting to resolve #4352". Important: Be sure that your description is helpful to the person clearing your PR. Mention any additional work needed, areas of concern, ideas, etc. Don’t be shy, no PR is ever perfect.</li>
</ol>
<p>
Once you submit a PR it will be reviewed and either returned with questions or suggestions or accepted with a merge. This process may take a bit so please be patient and feel free to reach out if you have concerns.
</p>
<h2>How can I get help?</h2>
<p>
Please visit <a href="https://casium.io">casium.io</a> to connect with other contributors.
</p>
<div class="repo-buttons">
<a class="link-reset" href="https://github.com/ai-labs-team/architecture">
<div class="button repo-button">Casium Repository</div>
</a>
<a class="link-reset" href="https://github.com/ai-labs-team/architecture-devtools">
<div class="button repo-button">Casium Devtools Repository</div>
</a>
</div>
</div>
</main>
<script type="text/javascript" src="scripts.js"></script>
</body>
</html>