-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathCONTRIBUTING.html
132 lines (109 loc) · 10.4 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
<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>Contributing to modsem • modsem</title><script src="deps/jquery-3.6.1/jquery-3.6.1.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="deps/font-awesome-6.4.2/css/all.min.css" rel="stylesheet"><link href="deps/font-awesome-6.4.2/css/v4-shims.min.css" rel="stylesheet"><script src="deps/headroom-0.11.0/headroom.min.js"></script><script src="deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="deps/search-1.0.0/fuse.min.js"></script><script src="deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="pkgdown.js"></script><meta property="og:title" content="Contributing to modsem"></head><body>
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
<nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container">
<a class="navbar-brand me-2" href="index.html">modsem</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">1.0.4</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div id="navbar" class="collapse navbar-collapse ms-3">
<ul class="navbar-nav me-auto"><li class="nav-item"><a class="nav-link" href="articles/modsem.html">Get started</a></li>
<li class="nav-item"><a class="nav-link" href="reference/index.html">Reference</a></li>
<li class="nav-item dropdown">
<button class="nav-link dropdown-toggle" type="button" id="dropdown-articles" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Articles</button>
<ul class="dropdown-menu" aria-labelledby="dropdown-articles"><li><a class="dropdown-item" href="articles/customizing.html">customizing interaction terms</a></li>
<li><a class="dropdown-item" href="articles/interaction_two_etas.html">interaction effects between endogenous variables</a></li>
<li><a class="dropdown-item" href="articles/lavaan.html">using lavaan functions</a></li>
<li><a class="dropdown-item" href="articles/lms_qml.html">LMS and QML approaches</a></li>
<li><a class="dropdown-item" href="articles/methods.html">methods</a></li>
<li><a class="dropdown-item" href="articles/observed_lms_qml.html">observed variables in the LMS- and QML approach</a></li>
<li><a class="dropdown-item" href="articles/plot_interactions.html">plotting interaction effects</a></li>
<li><a class="dropdown-item" href="articles/quadratic.html">quadratic effects</a></li>
</ul></li>
</ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search">
<input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="search.json"></form></li>
<li class="nav-item"><a class="external-link nav-link" href="https://github.com/Kss2k/modsem/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li>
</ul></div>
</div>
</nav><div class="container template-title-body">
<div class="row">
<main id="main" class="col-md-9"><div class="page-header">
<h1>Contributing to modsem</h1>
<small class="dont-index">Source: <a href="https://github.com/Kss2k/modsem/blob/main/CONTRIBUTING.md" class="external-link"><code>CONTRIBUTING.md</code></a></small>
</div>
<div id="contributing-to-modsem" class="section level1">
<p>Thank you for considering contributing to <code>modsem</code>! We welcome contributions to help improve this package for estimating interaction effects in structural equation modeling (SEM). To ensure a smooth collaboration, please follow the guidelines below.</p>
<div class="section level2">
<h2 id="getting-started">Getting Started<a class="anchor" aria-label="anchor" href="#getting-started"></a></h2>
<div class="section level3">
<h3 id="fork-and-clone-the-repository">Fork and Clone the Repository<a class="anchor" aria-label="anchor" href="#fork-and-clone-the-repository"></a></h3>
<ol style="list-style-type: decimal"><li>Fork the repository on GitHub.</li>
<li>Clone your fork to your local machine.</li>
</ol><div class="sourceCode" id="cb1"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" tabindex="-1"></a><span class="fu">git</span> clone https://github.com/your-username/modsem.git</span>
<span id="cb1-2"><a href="#cb1-2" tabindex="-1"></a><span class="bu">cd</span> modsem</span></code></pre></div>
</div>
<div class="section level3">
<h3 id="setting-up-your-development-environment">Setting up your Development Environment<a class="anchor" aria-label="anchor" href="#setting-up-your-development-environment"></a></h3>
<ol style="list-style-type: decimal"><li>Ensure you have R installed on your machine.</li>
<li>Install the package dependencies.</li>
</ol><div class="sourceCode" id="cb2"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span><span class="fu"><a href="https://rdrr.io/r/utils/install.packages.html" class="external-link">install.packages</a></span><span class="op">(</span><span class="st">"devtools"</span><span class="op">)</span></span>
<span><span class="fu">devtools</span><span class="fu">::</span><span class="fu"><a href="https://devtools.r-lib.org/reference/install_deps.html" class="external-link">install_deps</a></span><span class="op">(</span><span class="op">)</span></span></code></pre></div>
<ol start="3" style="list-style-type: decimal"><li>Install the <code>modsem</code> package from your local repository.</li>
</ol><div class="sourceCode" id="cb3"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span><span class="fu">devtools</span><span class="fu">::</span><span class="fu"><a href="https://devtools.r-lib.org/reference/install.html" class="external-link">install</a></span><span class="op">(</span><span class="op">)</span></span></code></pre></div>
</div>
</div>
<div class="section level2">
<h2 id="making-changes">Making Changes<a class="anchor" aria-label="anchor" href="#making-changes"></a></h2>
<div class="section level3">
<h3 id="creating-a-branch">Creating a Branch<a class="anchor" aria-label="anchor" href="#creating-a-branch"></a></h3>
<ol style="list-style-type: decimal"><li>Always create a new branch for your work.</li>
</ol><div class="sourceCode" id="cb4"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb4-1"><a href="#cb4-1" tabindex="-1"></a><span class="fu">git</span> checkout <span class="at">-b</span> your-branch-name</span></code></pre></div>
</div>
<div class="section level3">
<h3 id="making-your-changes">Making Your Changes<a class="anchor" aria-label="anchor" href="#making-your-changes"></a></h3>
<ol style="list-style-type: decimal"><li>Make your changes in the codebase.</li>
<li>Ensure that your changes are well-documented.</li>
<li>Write tests for your changes if applicable.</li>
</ol></div>
<div class="section level3">
<h3 id="contributing-to-vignettes">Contributing to Vignettes<a class="anchor" aria-label="anchor" href="#contributing-to-vignettes"></a></h3>
<p>We also encourage contributions to the vignettes. If you have a new use case or example, feel free to add or alter vignettes to help demonstrate the functionality of <code>modsem</code>.</p>
</div>
<div class="section level3">
<h3 id="running-tests">Running Tests<a class="anchor" aria-label="anchor" href="#running-tests"></a></h3>
<ol style="list-style-type: decimal"><li>Run the tests to ensure your changes do not break existing functionality.</li>
</ol><div class="sourceCode" id="cb5"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span><span class="fu">devtools</span><span class="fu">::</span><span class="fu"><a href="https://devtools.r-lib.org/reference/test.html" class="external-link">test</a></span><span class="op">(</span><span class="op">)</span></span></code></pre></div>
</div>
</div>
<div class="section level2">
<h2 id="submitting-your-changes">Submitting Your Changes<a class="anchor" aria-label="anchor" href="#submitting-your-changes"></a></h2>
<ol style="list-style-type: decimal"><li>Push your changes to your fork.</li>
</ol><div class="sourceCode" id="cb6"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb6-1"><a href="#cb6-1" tabindex="-1"></a><span class="fu">git</span> push origin your-branch-name</span></code></pre></div>
<ol start="2" style="list-style-type: decimal"><li>Open a pull request on GitHub against the <code>main</code> branch of the original repository.</li>
</ol><div class="section level3">
<h3 id="pull-request-guidelines">Pull Request Guidelines<a class="anchor" aria-label="anchor" href="#pull-request-guidelines"></a></h3>
<ol style="list-style-type: decimal"><li>Provide a clear and descriptive title for your pull request.</li>
<li>Describe the changes you made and why they are necessary.</li>
<li>Reference any related issues or pull requests.</li>
<li>Ensure all tests pass and there are no merge conflicts.</li>
</ol></div>
</div>
<div class="section level2">
<h2 id="reporting-issues">Reporting Issues<a class="anchor" aria-label="anchor" href="#reporting-issues"></a></h2>
<p>If you encounter any issues or have suggestions for improvements, please open an issue on GitHub. Provide as much detail as possible to help us understand and address the issue.</p>
</div>
</div>
</main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
</nav></aside></div>
<footer><div class="pkgdown-footer-left">
<p>Developed by Kjell Solem Slupphaug.</p>
</div>
<div class="pkgdown-footer-right">
<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.1.1.</p>
</div>
</footer></div>
</body></html>