Skip to content

Commit 0005c60

Browse files
kylejgillettkylejgillett
committed
fix broken contributing guidelines
1 parent cb7ca47 commit 0005c60

16 files changed

+6744
-6566
lines changed

‎docs/about.html‎

Lines changed: 269 additions & 269 deletions
Large diffs are not rendered by default.

‎docs/beginners_sounderpy_cookbook.html‎

Lines changed: 886 additions & 886 deletions
Large diffs are not rendered by default.

‎docs/beginners_sounderpy_cookbook.ipynb‎

Lines changed: 1076 additions & 1076 deletions
Large diffs are not rendered by default.

‎docs/community.html‎

Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,164 @@
1+
2+
3+
<!DOCTYPE html>
4+
<html class="writer-html5" lang="en" data-content_root="./">
5+
<head>
6+
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
7+
8+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9+
<title>🌍 Community &mdash; SounderPy v3.0.5 documentation</title>
10+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
11+
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
12+
13+
14+
<link rel="shortcut icon" href="https://raw.githubusercontent.com/kylejgillett/sounderpy/main/images/sounderpy_logo.png"/>
15+
<script src="_static/jquery.js?v=5d32c60e"></script>
16+
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
17+
<script src="_static/documentation_options.js?v=0f7a3e64"></script>
18+
<script src="_static/doctools.js?v=9bcbadda"></script>
19+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
20+
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
21+
<script src="_static/js/theme.js"></script>
22+
<link rel="author" title="About these documents" href="about.html" />
23+
<link rel="index" title="Index" href="genindex.html" />
24+
<link rel="search" title="Search" href="search.html" />
25+
<link rel="next" title="🌐 Tools for Getting Data" href="gettingdata.html" />
26+
<link rel="prev" title="❓ Troubleshooting" href="troubleshooting.html" />
27+
</head>
28+
29+
<body class="wy-body-for-nav">
30+
<div class="wy-grid-for-nav">
31+
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
32+
<div class="wy-side-scroll">
33+
<div class="wy-side-nav-search" >
34+
35+
36+
37+
<a href="index.html" class="icon icon-home">
38+
SounderPy
39+
<img src="https://raw.githubusercontent.com/kylejgillett/sounderpy/main/images/sounderpy_logo.png" class="logo" alt="Logo"/>
40+
</a>
41+
<div role="search">
42+
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
43+
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
44+
<input type="hidden" name="check_keywords" value="yes" />
45+
<input type="hidden" name="area" value="default" />
46+
</form>
47+
</div>
48+
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
49+
<p class="caption" role="heading"><span class="caption-text">General:</span></p>
50+
<ul class="current">
51+
<li class="toctree-l1"><a class="reference internal" href="about.html">📖 About</a></li>
52+
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">❓ Troubleshooting</a></li>
53+
<li class="toctree-l1 current"><a class="current reference internal" href="#">🌍 Community</a><ul>
54+
<li class="toctree-l2"><a class="reference internal" href="#submitting-issues-ideas-suggestions">Submitting Issues, Ideas, &amp; Suggestions</a></li>
55+
<li class="toctree-l2"><a class="reference internal" href="#contributing-to-sounderpy">Contributing to SounderPy</a></li>
56+
</ul>
57+
</li>
58+
</ul>
59+
<p class="caption" role="heading"><span class="caption-text">API Reference:</span></p>
60+
<ul>
61+
<li class="toctree-l1"><a class="reference internal" href="gettingdata.html">🌐 Tools for Getting Data</a></li>
62+
<li class="toctree-l1"><a class="reference internal" href="customdatasources.html">✏️ Custom Data Sources</a></li>
63+
<li class="toctree-l1"><a class="reference internal" href="plottingdata.html">📈 Tools for Plotting Data</a></li>
64+
<li class="toctree-l1"><a class="reference internal" href="helpertools.html">🛠️ Helper Tools</a></li>
65+
</ul>
66+
<p class="caption" role="heading"><span class="caption-text">Tutorials:</span></p>
67+
<ul>
68+
<li class="toctree-l1"><a class="reference internal" href="beginners_sounderpy_cookbook.html">👨‍🍳Beginner’s SounderPy Cookbook</a></li>
69+
<li class="toctree-l1"><a class="reference internal" href="examplegallery.html">📊 Plot Gallery</a></li>
70+
<li class="toctree-l1"><a class="reference internal" href="examplescripts.html">📝 Usage Examples</a></li>
71+
</ul>
72+
73+
</div>
74+
</div>
75+
</nav>
76+
77+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
78+
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
79+
<a href="index.html">SounderPy</a>
80+
</nav>
81+
82+
<div class="wy-nav-content">
83+
<div class="rst-content">
84+
<div role="navigation" aria-label="Page navigation">
85+
<ul class="wy-breadcrumbs">
86+
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
87+
<li class="breadcrumb-item active">🌍 Community</li>
88+
<li class="wy-breadcrumbs-aside">
89+
<a href="_sources/community.rst.txt" rel="nofollow"> View page source</a>
90+
</li>
91+
</ul>
92+
<hr/>
93+
</div>
94+
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
95+
<div itemprop="articleBody">
96+
97+
<section id="community">
98+
<h1>🌍 Community<a class="headerlink" href="#community" title="Link to this heading"></a></h1>
99+
<section id="submitting-issues-ideas-suggestions">
100+
<h2>Submitting Issues, Ideas, &amp; Suggestions<a class="headerlink" href="#submitting-issues-ideas-suggestions" title="Link to this heading"></a></h2>
101+
<p><em>Have an issue? Seeking Support?</em>
102+
- <a class="reference external" href="https://github.com/kylejgillett/sounderpy/issues">Open a GitHub Issue</a>
103+
- Shoot me an email! (<a class="reference external" href="mailto:kyle&#46;gillett&#37;&#52;&#48;und&#46;edu">kyle<span>&#46;</span>gillett<span>&#64;</span>und<span>&#46;</span>edu</a>)
104+
- Shoot me a DM on X (&#64;wxkylegillett)</p>
105+
</section>
106+
<section id="contributing-to-sounderpy">
107+
<h2>Contributing to SounderPy<a class="headerlink" href="#contributing-to-sounderpy" title="Link to this heading"></a></h2>
108+
<p>Contributions to this library are encouraged! Below are a few simple guidelines to follow if you are considering helping out this package.</p>
109+
<ul class="simple">
110+
<li><p><strong>Tackling open issues on Github</strong> – feel free to search through unresolved <a class="reference external" href="https://github.com/kylejgillett/sounderpy/issues">Github Issues</a> and propose a solution!</p></li>
111+
<li><p><strong>Contributing your code</strong> – if you have made local modifications to SounderPy, feel free to suggest adding your changes by opening a <a class="reference external" href="https://github.com/kylejgillett/sounderpy/pulls">GitHub pull request</a>.</p></li>
112+
<li><p><strong>Adding an entirely new feature</strong> – similarly to above, open a <a class="reference external" href="https://github.com/kylejgillett/sounderpy/pulls">GitHub pull request</a> with the proposed additions.</p></li>
113+
<li><p><strong>Creating tutorials</strong> – So much of the code we write is best understood with comprehensive tutorials. I highly encourage anyone to build tutorials that explain the code, explain a specific use/task, or to simply provide more examples. Do so by opening a <a class="reference external" href="https://github.com/kylejgillett/sounderpy/pulls">GitHub pull request</a>.</p></li>
114+
</ul>
115+
<p><strong>To contribute to SounderPy…</strong></p>
116+
<ol class="arabic">
117+
<li><p>In GitHub, fork the SounderPy repository (repo) into your profile.</p></li>
118+
<li><p>Pull down the forked repo to your local machine.</p></li>
119+
<li><p>After making changes, commit them to your forked repo.</p></li>
120+
<li><p>Finally, open a Pull Request.</p>
121+
<blockquote>
122+
<div><ul class="simple">
123+
<li><p>Pull requests, for any contribution, should include a detailed explanation of the code, why it’s needed, and what it fixes/replaces.</p></li>
124+
<li><p>Ensure that your code is well formatted, clean, commented and easy to read.</p></li>
125+
<li><p><strong>IMPORTANT</strong>: The goal of SounderPy is to make sounding analysis available to everyone – beginners and experts alike. As such, SounderPy code should be <em>easy to read</em>, not just well-documented. In the case of this library, code that is clean and <em>easy to read</em> is valued more over code that is “fancy”, “too-complex” and harder to read.</p></li>
126+
</ul>
127+
</div></blockquote>
128+
</li>
129+
</ol>
130+
</section>
131+
</section>
132+
133+
134+
</div>
135+
</div>
136+
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
137+
<a href="troubleshooting.html" class="btn btn-neutral float-left" title="❓ Troubleshooting" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
138+
<a href="gettingdata.html" class="btn btn-neutral float-right" title="🌐 Tools for Getting Data" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
139+
</div>
140+
141+
<hr/>
142+
143+
<div role="contentinfo">
144+
<p>&#169; Copyright 2024, Kyle J Gillett.</p>
145+
</div>
146+
147+
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
148+
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
149+
provided by <a href="https://readthedocs.org">Read the Docs</a>.
150+
151+
152+
</footer>
153+
</div>
154+
</div>
155+
</section>
156+
</div>
157+
<script>
158+
jQuery(function () {
159+
SphinxRtdTheme.Navigation.enable(true);
160+
});
161+
</script>
162+
163+
</body>
164+
</html>

0 commit comments

Comments
 (0)