-
Notifications
You must be signed in to change notification settings - Fork 0
/
contributing.html
146 lines (110 loc) · 7.61 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
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
<!doctype html>
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>trackaday documentation</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" type="image/x-icon" href="./images/favicon.ico">
<link rel="stylesheet" href="./styles/style.css">
<link rel="stylesheet" href="./styles/dark.css">
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top visible-xs">
<a href="./" class="navbar-brand">trackaday documentation</a>
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
</div>
<div class="xs-menu menu" id="mobile-menu">
<div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu>
</div>
<div class="container-fluid main">
<div class="row main">
<div class="hidden-xs menu">
<compodoc-menu mode="normal"></compodoc-menu>
</div>
<!-- START CONTENT -->
<div class="content getting-started">
<div class="content-data">
<h1 id="how-to-contribute">How to contribute</h1>
<p>Thanks for taking interest and contributing to this project.</p>
<h2 id="did-you-find-a-bug"><strong>Did you find a bug?</strong></h2>
<ul>
<li><p><strong>Ensure the bug was not already reported</strong> by searching on GitHub under <a href="https://github.com/SahithiAmmana/trackaday/issues">Issues</a>.</p>
</li>
<li><p>If you're unable to find an open issue addressing the problem, <a href="https://github.com/SahithiAmmana/trackaday/issues/new">open a new one</a>. Be sure to include a <strong>title and clear description</strong>, as much relevant information as possible, and a <strong>code sample</strong> or an <strong>executable test case</strong> demonstrating the expected behavior that is not occurring.</p>
</li>
<li><p>Before submitting a bug, make sure it is reproduced on the latest version of the project.</p>
</li>
</ul>
<h3 id="how-do-i-submit-a-good-bug-report">How do I submit a good bug report?</h3>
<p>Bugs are tracked as <a href="https://guides.github.com/features/issues/">GitHub issues</a>. Explain the problem and include additional details to help maintainers reproduce the problem:</p>
<ul>
<li>Use a clear and descriptive title for the issue to identify the problem.</li>
<li>Describe the exact steps which reproduce the problem in as many details as possible.</li>
<li>Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use <a href="https://help.github.com/articles/markdown-basics/#multiple-lines">Markdown code blocks</a>.</li>
<li>Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.</li>
<li>Explain which behavior you expected to see instead and why.</li>
<li><strong>Include screenshots and animated GIFs</strong> which show you following the described steps and clearly demonstrate the problem. You can use <a href="https://www.cockos.com/licecap/">this tool</a> to record GIFs on macOS and Windows, and <a href="https://github.com/colinkeenan/silentcast">this tool</a> on Linux.</li>
<li><strong>If the problem wasn't triggered by a specific action</strong>, describe what you were doing before the problem happened and share more information using the guidelines below.</li>
</ul>
<h2 id="testing">Testing</h2>
<p>We have most part of our code in Python. Hence, whenever changes are added to the repo, it is highly advised to add unit tests for that. It helps track bugs and maintain the highest level of test coverage for the project.</p>
<h2 id="submitting-changes">Submitting changes</h2>
<p>Please send a <a href="https://github.com/SahithiAmmana/trackaday/pulls/">GitHub Pull Request to https://github.com/SahithiAmmana/trackaday</a> with a clear list of what you've done (read more about <a href="http://help.github.com/pull-requests/">pull requests</a>). We can always use more test coverage. Please follow our coding conventions (below) and make sure all of your commits are atomic (one feature per commit).</p>
<p>Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:</p>
<div><pre class="line-numbers"><code class="language-none">$ git commit -m "A brief summary of the commit
>
> A paragraph describing what changed and its impact."</code></pre></div><h2 id="coding-conventions">Coding conventions</h2>
<p>Start reading our code and you'll get the hang of it. We optimize for readability. We indent using two spaces (soft tabs)</p>
<h2 id="code-of-conduct">Code of Conduct</h2>
<p>This project and everyone participating in it is governed by the <a href="https://github.com/SahithiAmmana/trackaday/blob/main/CODE-OF-CONDUCT.md">Project Code of Conduct</a>. By participating, you are expected to uphold this code. Please report unacceptable behavior to the repo owner.</p>
</div><div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
<!-- END CONTENT -->
</div>
</div>
<label class="dark-mode-switch">
<input type="checkbox">
<span class="slider">
<svg class="slider-icon" viewBox="0 0 24 24" fill="none" height="20" stroke="#000" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" width="20" xmlns="http://www.w3.org/2000/svg">
<path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"></path>
</svg>
</span>
</label>
<script>
var COMPODOC_CURRENT_PAGE_DEPTH = 0;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'getting-started';
var COMPODOC_CURRENT_PAGE_URL = 'contributing.html';
var MAX_SEARCH_RESULTS = 15;
</script>
<script src="./js/libs/custom-elements.min.js"></script>
<script src="./js/libs/lit-html.js"></script>
<script src="./js/menu-wc.js" defer></script>
<script nomodule src="./js/menu-wc_es5.js" defer></script>
<script src="./js/libs/bootstrap-native.js"></script>
<script src="./js/libs/es6-shim.min.js"></script>
<script src="./js/libs/EventDispatcher.js"></script>
<script src="./js/libs/promise.min.js"></script>
<script src="./js/libs/zepto.min.js"></script>
<script src="./js/compodoc.js"></script>
<script src="./js/tabs.js"></script>
<script src="./js/menu.js"></script>
<script src="./js/libs/clipboard.min.js"></script>
<script src="./js/libs/prism.js"></script>
<script src="./js/sourceCode.js"></script>
<script src="./js/search/search.js"></script>
<script src="./js/search/lunr.min.js"></script>
<script src="./js/search/search-lunr.js"></script>
<script src="./js/search/search_index.js"></script>
<script src="./js/lazy-load-graphs.js"></script>
</body>
</html>