-
Notifications
You must be signed in to change notification settings - Fork 7
/
contrib.html
230 lines (209 loc) · 11.9 KB
/
contrib.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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Contributor Guide — GEOPM documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Developer Guide" href="devel.html" />
<link rel="prev" title="User Guide for GEOPM Runtime" href="runtime.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="index.html" class="icon icon-home">
GEOPM
<img src="https://geopm.github.io/images/geopm-logo-clear.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="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="overview.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guides.html">User Guides</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Contributor Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#bug-report">Bug Report</a></li>
<li class="toctree-l2"><a class="reference internal" href="#feature-request">Feature Request</a></li>
<li class="toctree-l2"><a class="reference internal" href="#change-request">Change Request</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#review-process">Review process</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="devel.html">Developer Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="publications.html">Publications</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference.html">Reference Manual</a></li>
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</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="index.html">GEOPM</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="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Contributor Guide</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/contrib.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="contributor-guide">
<h1>Contributor Guide<a class="headerlink" href="#contributor-guide" title="Link to this heading"></a></h1>
<p>This file describes how to contribute to the GEOPM project: how to create bug
reports, request features, and contribute to the repository. All feedback is
appreciated.</p>
<p>Refer to the developers guide for more details about how to make changes to the
source code. The guide for developers is maintained here:</p>
<p><a class="reference external" href="https://geopm.github.io/devel.html">https://geopm.github.io/devel.html</a></p>
<section id="bug-report">
<h2>Bug Report<a class="headerlink" href="#bug-report" title="Link to this heading"></a></h2>
<p>Please file an issue on our GitHub site for any bug observed:</p>
<p><a class="reference external" href="https://github.com/geopm/geopm/issues/new/choose">https://github.com/geopm/geopm/issues/new/choose</a></p>
<p>and select the “Bug report” template.</p>
<p>If possible, please reproduce issue with the –enable-debug option
passed to configure at build time and then report any error messages
emitted by GEOPM at run time. Please provide the version of GEOPM
that produced the problem. The GEOPM version can be found by running
the command</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">geopmread</span> <span class="o">--</span><span class="n">version</span>
</pre></div>
</div>
<p>Providing code that is small and reproduces the issue is nice to have.</p>
</section>
<section id="feature-request">
<h2>Feature Request<a class="headerlink" href="#feature-request" title="Link to this heading"></a></h2>
<p>Please submit an issue on GitHub for any feature requests using the
“Feature request” template. Feature request issues should be titled
as a user story of the form:</p>
<blockquote>
<div><p>“As a <ROLE> I would like <FEATURE>”</p>
</div></blockquote>
<p>in this way the author of the issue identifies the role that will
benefit from the feature and then describes the feature iteslf.
Common roles include “user of the GEOPM runtime”, “user of the GEOPM
service”, “developer of GEOPM”, etc. Please be as specific as
possible when identifying the role, e.g. “user of the geopmsession
command line tool” is preferred to “user of the GEOPM service”.</p>
<p>When planning to implement a new feature as a contribution to the main
repository, please start this collaboration by creating a feature
request issue. Please open the feature issue as soon as possible in
the process of planning the work.</p>
</section>
<section id="change-request">
<h2>Change Request<a class="headerlink" href="#change-request" title="Link to this heading"></a></h2>
<p>Changes to GEOPM are submitted by opening a pull request on GitHub
from a fork of GEOPM. Including a Signed-off-by: line in the commit
message is appreciated, but not required. All pull requests to the
geopm/geopm repository on GitHub will automatically be submitted to
GitHub Actions for unit testing.</p>
<p>Making a pull request is a step in a process. The first step in this
process is creating an issue from one the “Bug report”, “Feature
request”, or “Story” templates. This step identifies the high level
goal for one or more changes to the repository.</p>
<p>Each change to the repository is identified with an issue created
using one of the issues templates that begins “Change - “. The
“Change” issue should reference the “Bug report,” “Feature request,”
or “Story” that the change relates to. This is done with a “Relates
to #XXXX” note in the issue description.</p>
<p>Each pull request will close a “Change” issue by filling in the “Fixes
#XXXX” notation in the pull request template, it may also close the
high level issue, if this is the last required change to fix the bug,
complete the feature, or accomplish the story described in the high
level issue. Note that the requirements for the pull request should
be documented in the “Change” issue, not in the pull request itself.</p>
<p>The link for creating an issue is here:</p>
<p><a class="reference external" href="https://github.com/geopm/geopm/issues/new/choose">https://github.com/geopm/geopm/issues/new/choose</a></p>
<p>The link for creating a pull request is here:</p>
<p><a class="reference external" href="https://github.com/geopm/geopm/pulls">https://github.com/geopm/geopm/pulls</a></p>
<p>The link to the results of the unit testing can be found under the
actions tab on the GEOPM GitHub webpage:</p>
<p><a class="reference external" href="https://github.com/geopm/geopm/actions">https://github.com/geopm/geopm/actions</a></p>
<p>We encourage users and developers of the GEOPM software to participate
in our code review process through GitHub.</p>
<section id="review-process">
<h3>Review process<a class="headerlink" href="#review-process" title="Link to this heading"></a></h3>
<p>Our process for requesting a pull request to be reviewed and merged
is as follows:</p>
<ol class="arabic simple">
<li><p>An issue has been created about the problem that the pull request
is solving. Note that most PRs that change source code refer to
an issue created with one of the “Change - “ templates.</p></li>
<li><p>Author creates a branch reflecting the issue number,
e.g. “issue-1234”.</p></li>
<li><p>Changes are made on that branch and pushed to the author’s fork of
the GEOPM repository.</p></li>
<li><p>The author submits the pull request based on the issue branch.
Please refer to the Git documentation on how to create pull
request:
<a class="reference external" href="https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests">https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests</a>.
Note that the pull request will be filled with a template.
Selecting the “Preview” tab to render the markdown in the template
may be helpful when editing the pull request text.</p></li>
<li><p>Check that all of the requirements in the issue referenced by the
PR have been met.</p></li>
<li><p>The submitter may optionally request specific people to be
reviewers. Otherwise, any GEOPM maintainer may be an approver for
the pull request. The <code class="docutils literal notranslate"><span class="pre">#code-review</span></code> channel on GEOPM’s slack
organization may be used to alert maintainers of a review request.</p></li>
<li><p>During the review process, a reviewer may request changes to the
pull request. If possible, these changes should be submitted as
new commits without rebasing or squashing to simplify the reader’s
ability to view changes.</p></li>
<li><p>When the pull request is accepted by the reviewer(s), it will be
marked “Approve”. Once the request is approved by all reviewers
and all CI checks are passing, the change will be integrated into
the GEOPM development branch by a maintainer.</p></li>
</ol>
</section>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="runtime.html" class="btn btn-neutral float-left" title="User Guide for GEOPM Runtime" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="devel.html" class="btn btn-neutral float-right" title="Developer Guide" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2015 - 2024 Intel Corporation. All rights reserved..</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>