-
Notifications
You must be signed in to change notification settings - Fork 17
/
Copy pathcontribute.html
164 lines (149 loc) · 10.9 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
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
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Contribute — kOS 1.4.0.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/kos_theme.css" type="text/css" />
<link rel="shortcut icon" href="_static/favicon.ico"/>
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="author" title="About these documents" href="about.html" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="copyright" title="Copyright" href="copyright.html" />
<link rel="next" title="Getting Help" href="getting_help.html" />
<link rel="prev" title="Trajectories" href="addons/Trajectories.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="contents.html" class="icon icon-home"> kOS
<img src="_static/kos_logo_small.png" class="logo" alt="Logo"/>
</a>
<div class="version">
1.4.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="contents.html">Table of Contents</a></li>
<li class="toctree-l1"><a class="reference internal" href="downloads_links.html">Downloads and Links</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="library.html">Community Example Library</a></li>
<li class="toctree-l1"><a class="reference internal" href="general.html">General</a></li>
<li class="toctree-l1"><a class="reference internal" href="language.html">Language</a></li>
<li class="toctree-l1"><a class="reference internal" href="math.html">Mathematics</a></li>
<li class="toctree-l1"><a class="reference internal" href="commands.html">Commands</a></li>
<li class="toctree-l1"><a class="reference internal" href="structures.html">Structures</a></li>
<li class="toctree-l1"><a class="reference internal" href="addons.html">Addons</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Contribute</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_help.html">Getting Help</a></li>
<li class="toctree-l1"><a class="reference internal" href="changes.html">Changes</a></li>
<li class="toctree-l1"><a class="reference internal" href="about.html">About</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="contents.html">kOS</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="contents.html" class="icon icon-home"></a> »</li>
<li>Contribute</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/contribute.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="contribute">
<span id="id1"></span><h1>Contribute<a class="headerlink" href="#contribute" title="Permalink to this heading">¶</a></h1>
<section id="how-to-contribute-to-this-project">
<h2>How to Contribute to this Project<a class="headerlink" href="#how-to-contribute-to-this-project" title="Permalink to this heading">¶</a></h2>
<p>Do you know or are willing to learn C# and the <strong>KSP</strong> public API? Great, we could use your help! The source code for <strong>kOS</strong> is kept on <a class="reference external" href="https://github.com/KSP-KOS">github</a> under <a class="reference external" href="https://github.com/KSP-KOS/KOS">https://github.com/KSP-KOS/KOS</a>.</p>
<p>If you are already quite familiar with git and Github, the usual Github project development path is used:</p>
<blockquote>
<div><ul class="simple">
<li><p>Tell github to fork the main repository to your own github clone of it.</p></li>
<li><p>Clone your fork to your local computer.</p></li>
<li><p>On your local computer, make a branch from <code class="docutils literal notranslate"><span class="pre">develop</span></code> (don’t edit <code class="docutils literal notranslate"><span class="pre">develop</span></code> directly) and make your changes in your branch.</p></li>
<li><p>Commit your changes and push them up to the same branch name on your github fork.</p></li>
<li><p>Make a Pull Request on Github to merge the branch from your fork to the <code class="docutils literal notranslate"><span class="pre">develop</span></code> branch of the main repository.</p></li>
<li><p>Wait for a developer to notice the Pull Request and start examining it. There should be at the very least a comment letting you know it’s being looked at, within a short time. KSP-KOS is quite actively developed and someone should notice it soon.</p></li>
<li><p>Your request is more likely to get merged quickly if you make sure the <code class="docutils literal notranslate"><span class="pre">develop</span></code> branch you start from is always up to date with the latest upstream develop when you first split your branch from it. If it takes a long time to finish, it may be a good idea to check again before making the Pull Request to see if there’s been any new upstream <code class="docutils literal notranslate"><span class="pre">develop</span></code> changes, and merge them into your branch yourself so the rest of the team has an easier time deciphering the git diff output.</p></li>
</ul>
</div></blockquote>
<p>If you do know how to program on large projects and would like to contribute, but just aren’t familiar with how git and Github do repository management, contact one of the developers and ask for help on how to get started, or ask to be added to the Slack channel first.</p>
</section>
<section id="slack-chat">
<h2>Slack Chat<a class="headerlink" href="#slack-chat" title="Permalink to this heading">¶</a></h2>
<p>There is an active Slack chat channel where the developers often discuss complex ideas before even mentioning them in a github issue or pull request. If you wish to be added to this channel, please contact one of the main developers to ask to be invited to the channel.</p>
</section>
<section id="how-to-get-credited-in-the-next-release">
<h2>How to get credited in the next Release<a class="headerlink" href="#how-to-get-credited-in-the-next-release" title="Permalink to this heading">¶</a></h2>
<p>After version 0.19.0, Only people who opt-in to being credited will be mentioned in the release notes.</p>
<p>When you contribute to the development of the mod, if you wish to be named a certain way in the next release notes, then add your edit to the <code class="docutils literal notranslate"><span class="pre">###</span> <span class="pre">Contributors</span></code> section of the CHANGELOG.md file in your pull request.
In past releases we have tried to scour the github history to find all authors and it’s a bit of a pain to pull the data together. In future releases we will simply rely on this opt-in technique. If you don’t edit the file, you won’t be opted-in to the contributors section. This also avoids the hassle of having to ask everyone’s permission in the last days of putting a release out, and then waiting for people’s responses.</p>
</section>
<section id="how-to-edit-this-documentation">
<h2>How to Edit this Documentation<a class="headerlink" href="#how-to-edit-this-documentation" title="Permalink to this heading">¶</a></h2>
<p>This documentation was written using <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> and compiled into HTML using <a class="reference external" href="http://sphinx-doc.org/">Sphinx</a> and the <a class="reference external" href="https://github.com/snide/sphinx_rtd_theme">Read The Docs Theme</a>.</p>
<p>To re-build the documentation tree locally, get a local clone of the project, <cite>cd</cite> into the <cite>doc/</cite> directory, and do these two commands:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>make clean
make html
</pre></div>
</div>
<p>Note, this requires you set up Sphinx and Read-the-Docs first, as described in the links above.</p>
<p>This documentation system was first set up for us by Johann Goetz, to whom we are grateful:</p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="addons/Trajectories.html" class="btn btn-neutral float-left" title="Trajectories" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="getting_help.html" class="btn btn-neutral float-right" title="Getting Help" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© <a href="copyright.html">Copyright</a> 2013-2021, Developed and maintained by kOS Team, Originally By Nivekk.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>