Skip to content

Commit 197fb2b

Browse files
mkphuthimkphuthi
committed
Merge branch 'gh-pages' of https://github.com/BattModels/asimtools into gh-pages
2 parents b4f5fce + 19a1b65 commit 197fb2b

File tree

267 files changed

+47757
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

267 files changed

+47757
-0
lines changed

‎.nojekyll

Whitespace-only changes.

‎build/CONTRIBUTING.html

+192
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,192 @@
1+
<!DOCTYPE html>
2+
<html class="writer-html5" lang="en" >
3+
<head>
4+
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
5+
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7+
<title>Contributing &mdash; asimtools 1.0.0 documentation</title>
8+
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
9+
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
10+
<!--[if lt IE 9]>
11+
<script src="_static/js/html5shiv.min.js"></script>
12+
<![endif]-->
13+
14+
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=af2ce170"></script>
15+
<script src="_static/doctools.js?v=888ff710"></script>
16+
<script src="_static/sphinx_highlight.js?v=4825356b"></script>
17+
<script src="_static/js/theme.js"></script>
18+
<link rel="index" title="Index" href="genindex.html" />
19+
<link rel="search" title="Search" href="search.html" />
20+
</head>
21+
22+
<body class="wy-body-for-nav">
23+
<div class="wy-grid-for-nav">
24+
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
25+
<div class="wy-side-scroll">
26+
<div class="wy-side-nav-search" >
27+
<a href="index.html" class="icon icon-home"> asimtools
28+
</a>
29+
<div role="search">
30+
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
31+
<input type="text" name="q" placeholder="Search docs" />
32+
<input type="hidden" name="check_keywords" value="yes" />
33+
<input type="hidden" name="area" value="default" />
34+
</form>
35+
</div>
36+
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
37+
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
38+
<ul>
39+
<li class="toctree-l1"><a class="reference internal" href="include_readme.html">README</a></li>
40+
<li class="toctree-l1"><a class="reference internal" href="usage.html">Running asimmodules</a></li>
41+
<li class="toctree-l1"><a class="reference internal" href="asimplify.html">Custom asimmodules</a></li>
42+
<li class="toctree-l1"><a class="reference internal" href="workflows.html">Workflows</a></li>
43+
<li class="toctree-l1"><a class="reference internal" href="modules.html">API Docs</a></li>
44+
<li class="toctree-l1"><a class="reference internal" href="include_contributing.html">Contributing</a></li>
45+
</ul>
46+
47+
</div>
48+
</div>
49+
</nav>
50+
51+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
52+
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
53+
<a href="index.html">asimtools</a>
54+
</nav>
55+
56+
<div class="wy-nav-content">
57+
<div class="rst-content">
58+
<div role="navigation" aria-label="Page navigation">
59+
<ul class="wy-breadcrumbs">
60+
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
61+
<li>Contributing</li>
62+
<li class="wy-breadcrumbs-aside">
63+
<a href="_sources/CONTRIBUTING.md.txt" rel="nofollow"> View page source</a>
64+
</li>
65+
</ul>
66+
<hr/>
67+
</div>
68+
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
69+
<div itemprop="articleBody">
70+
71+
<section id="contributing">
72+
<h1>Contributing<a class="headerlink" href="#contributing" title="Permalink to this heading"></a></h1>
73+
<p>When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.</p>
74+
<p>Please note we have a code of conduct, please follow it in all your interactions with the project.</p>
75+
<p>There are two main ways to contribute. One is to make changes to the existing
76+
codes and asimmodules. In this case, please make sure your change passes tests or
77+
submit a test accordinly. The second way to contribute is to add a new asimmodule
78+
to the core set of asimmodules. Reviewers will work with you to make sure your new
79+
asimmodule follows best practice including using utils, syntax highlighting, docs
80+
and tests.</p>
81+
<section id="pull-request-process">
82+
<h2>Pull Request Process<a class="headerlink" href="#pull-request-process" title="Permalink to this heading"></a></h2>
83+
<ol class="arabic simple">
84+
<li><p>Ensure any install or build dependencies are removed before the end of the layer when doing a build.</p></li>
85+
<li><p>Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.</p></li>
86+
<li><p>Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is <a class="reference external" href="http://semver.org/">SemVer</a>.</p></li>
87+
<li><p>You may merge the Pull Request in once you have the sign-off of one other developer, or if you do not have permission to do that, you may request the other reviewer to merge it for you.</p></li>
88+
</ol>
89+
</section>
90+
<section id="code-of-conduct">
91+
<h2>Code of Conduct<a class="headerlink" href="#code-of-conduct" title="Permalink to this heading"></a></h2>
92+
<section id="our-pledge">
93+
<h3>Our Pledge<a class="headerlink" href="#our-pledge" title="Permalink to this heading"></a></h3>
94+
<p>In the interest of fostering an open and welcoming environment, we as
95+
contributors and maintainers pledge to making participation in our project and
96+
our community a harassment-free experience for everyone, regardless of age, body
97+
size, disability, ethnicity, gender identity and expression, level of experience,
98+
nationality, personal appearance, race, religion, or sexual identity and
99+
orientation.</p>
100+
</section>
101+
<section id="our-standards">
102+
<h3>Our Standards<a class="headerlink" href="#our-standards" title="Permalink to this heading"></a></h3>
103+
<p>Examples of behavior that contributes to creating a positive environment
104+
include:</p>
105+
<ul class="simple">
106+
<li><p>Using welcoming and inclusive language</p></li>
107+
<li><p>Being respectful of differing viewpoints and experiences</p></li>
108+
<li><p>Gracefully accepting constructive criticism</p></li>
109+
<li><p>Focusing on what is best for the community</p></li>
110+
<li><p>Showing empathy towards other community members</p></li>
111+
</ul>
112+
<p>Examples of unacceptable behavior by participants include:</p>
113+
<ul class="simple">
114+
<li><p>The use of sexualized language or imagery and unwelcome sexual attention or
115+
advances</p></li>
116+
<li><p>Trolling, insulting/derogatory comments, and personal or political attacks</p></li>
117+
<li><p>Public or private harassment</p></li>
118+
<li><p>Publishing others’ private information, such as a physical or electronic
119+
address, without explicit permission</p></li>
120+
<li><p>Other conduct which could reasonably be considered inappropriate in a
121+
professional setting</p></li>
122+
</ul>
123+
</section>
124+
<section id="our-responsibilities">
125+
<h3>Our Responsibilities<a class="headerlink" href="#our-responsibilities" title="Permalink to this heading"></a></h3>
126+
<p>Project maintainers are responsible for clarifying the standards of acceptable
127+
behavior and are expected to take appropriate and fair corrective action in
128+
response to any instances of unacceptable behavior.</p>
129+
<p>Project maintainers have the right and responsibility to remove, edit, or
130+
reject comments, commits, code, wiki edits, issues, and other contributions
131+
that are not aligned to this Code of Conduct, or to ban temporarily or
132+
permanently any contributor for other behaviors that they deem inappropriate,
133+
threatening, offensive, or harmful.</p>
134+
</section>
135+
<section id="scope">
136+
<h3>Scope<a class="headerlink" href="#scope" title="Permalink to this heading"></a></h3>
137+
<p>This Code of Conduct applies both within project spaces and in public spaces
138+
when an individual is representing the project or its community. Examples of
139+
representing a project or community include using an official project e-mail
140+
address, posting via an official social media account, or acting as an appointed
141+
representative at an online or offline event. Representation of a project may be
142+
further defined and clarified by project maintainers.</p>
143+
</section>
144+
<section id="enforcement">
145+
<h3>Enforcement<a class="headerlink" href="#enforcement" title="Permalink to this heading"></a></h3>
146+
<p>Instances of abusive, harassing, or otherwise unacceptable behavior may be
147+
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
148+
complaints will be reviewed and investigated and will result in a response that
149+
is deemed necessary and appropriate to the circumstances. The project team is
150+
obligated to maintain confidentiality with regard to the reporter of an incident.
151+
Further details of specific enforcement policies may be posted separately.</p>
152+
<p>Project maintainers who do not follow or enforce the Code of Conduct in good
153+
faith may face temporary or permanent repercussions as determined by other
154+
members of the project’s leadership.</p>
155+
</section>
156+
<section id="attribution">
157+
<h3>Attribution<a class="headerlink" href="#attribution" title="Permalink to this heading"></a></h3>
158+
<p>This Code of Conduct is adapted from the <a class="reference external" href="http://contributor-covenant.org">Contributor Covenant</a>, version 1.4,
159+
available at <a class="reference external" href="http://contributor-covenant.org/version/1/4/">http://contributor-covenant.org/version/1/4</a></p>
160+
</section>
161+
</section>
162+
</section>
163+
164+
165+
</div>
166+
</div>
167+
<footer>
168+
169+
<hr/>
170+
171+
<div role="contentinfo">
172+
<p>&#169; Copyright 2023, Mgcini Keith Phuthi.</p>
173+
</div>
174+
175+
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
176+
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
177+
provided by <a href="https://readthedocs.org">Read the Docs</a>.
178+
179+
180+
</footer>
181+
</div>
182+
</div>
183+
</section>
184+
</div>
185+
<script>
186+
jQuery(function () {
187+
SphinxRtdTheme.Navigation.enable(true);
188+
});
189+
</script>
190+
191+
</body>
192+
</html>

0 commit comments

Comments
 (0)