You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<ahref="examples/example_python_api_extended.html" title="Intensity Duration Frequency Analyse - EXTENDED"
31
+
accesskey="P">previous</a> |</li>
32
+
<liclass="nav-item nav-item-0"><ahref="index.html">Intensity Duration Frequency Analyse 0.3.1 documentation</a> »</li>
33
+
<liclass="nav-item nav-item-this"><ahref="">Contributing to This Project</a></li>
34
+
</ul>
35
+
</div>
36
+
37
+
<divclass="document">
38
+
<divclass="documentwrapper">
39
+
<divclass="bodywrapper">
40
+
<divclass="body" role="main">
41
+
42
+
<sectionid="contributing-to-this-project">
43
+
<h1>Contributing to This Project<aclass="headerlink" href="#contributing-to-this-project" title="Link to this heading">¶</a></h1>
44
+
<p>Thank you for considering contributing to this project! Your help is greatly appreciated.</p>
45
+
<sectionid="how-to-contribute">
46
+
<h2>How to Contribute<aclass="headerlink" href="#how-to-contribute" title="Link to this heading">¶</a></h2>
47
+
<sectionid="reporting-issues">
48
+
<h3>Reporting Issues<aclass="headerlink" href="#reporting-issues" title="Link to this heading">¶</a></h3>
49
+
<p>If you encounter a bug, have a feature request, or need clarification, please open an issue in the <aclass="reference external" href="https://github.com/MarkusPic/intensity_duration_frequency_analysis/issues">GitHub Issues</a> section. When reporting a bug, include:</p>
50
+
<ulclass="simple">
51
+
<li><p>A clear description of the issue</p></li>
52
+
<li><p>Steps to reproduce</p></li>
53
+
<li><p>Expected vs. actual behavior</p></li>
54
+
<li><p>Any relevant error messages or logs</p></li>
55
+
</ul>
56
+
</section>
57
+
<sectionid="submitting-code-changes">
58
+
<h3>Submitting Code Changes<aclass="headerlink" href="#submitting-code-changes" title="Link to this heading">¶</a></h3>
59
+
<olclass="arabic">
60
+
<li><p><strong>Fork the repository</strong> and clone it locally.</p></li>
61
+
<li><p><strong>Create a new branch</strong> for your feature or fix:</p>
<li><p><strong>Commit your changes</strong> with a meaningful message:</p>
73
+
<divclass="highlight-sh notranslate"><divclass="highlight"><pre><span></span>git<spanclass="w"></span>commit<spanclass="w"></span>-m<spanclass="w"></span><spanclass="s2">"Describe your change briefly"</span>
74
+
</pre></div>
75
+
</div>
76
+
</li>
77
+
<li><p><strong>Push the branch</strong> to your fork:</p>
<li><p><strong>Create a Pull Request (PR)</strong> from your branch to the <codeclass="docutils literal notranslate"><spanclass="pre">main</span></code> branch.</p></li>
83
+
</ol>
84
+
<sectionid="code-style">
85
+
<h4>Code Style<aclass="headerlink" href="#code-style" title="Link to this heading">¶</a></h4>
86
+
<p>This project follows standard Python best practices (<aclass="reference external" href="https://pep8.org">PEP 8</a>).</p>
87
+
<p>Please ensure your code is typed where applicable using type hints.</p>
88
+
<p>Make sure that every function has a docstring with types. We use the <aclass="reference external" href="https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings">Google style docstring format</a>. Here is an <aclass="reference external" href="https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html">example for a Google style docstring</a>.</p>
89
+
</section>
90
+
</section>
91
+
<sectionid="writing-tests">
92
+
<h3>Writing Tests<aclass="headerlink" href="#writing-tests" title="Link to this heading">¶</a></h3>
93
+
<p>If your contribution includes code changes, please add or update tests to maintain high code quality. We use <codeclass="docutils literal notranslate"><spanclass="pre">pytest</span></code> for testing. All tests are located in the tests folder:</p>
<p>Ensure all tests pass before submitting your PR.</p>
98
+
</section>
99
+
<sectionid="reviewing-pull-requests">
100
+
<h3>Reviewing Pull Requests<aclass="headerlink" href="#reviewing-pull-requests" title="Link to this heading">¶</a></h3>
101
+
<p>We encourage contributors to review open PRs and provide constructive feedback.</p>
102
+
</section>
103
+
<sectionid="donate">
104
+
<h3>Donate<aclass="headerlink" href="#donate" title="Link to this heading">¶</a></h3>
105
+
<p>If you find this project useful, consider supporting it by <aclass="reference external" href="https://www.buymeacoffee.com/MarkusP">buying me a coffee</a>.</p>
106
+
</section>
107
+
<sectionid="other-ways-to-contribute">
108
+
<h3>Other Ways to Contribute<aclass="headerlink" href="#other-ways-to-contribute" title="Link to this heading">¶</a></h3>
109
+
<ulclass="simple">
110
+
<li><p>Writing tutorials or examples using <aclass="reference external" href="https://docs.github.com/en/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists">GitHub Gists</a> and referencing them in <aclass="reference external" href="https://github.com/MarkusPic/intensity_duration_frequency_analysis/discussions/categories/show-and-tell">discussions</a>.</p></li>
111
+
<li><p>Fixing typos and improving the documentation by opening issues or creating pull requests.</p></li>
112
+
</ul>
113
+
</section>
114
+
</section>
115
+
<sectionid="getting-help">
116
+
<h2>Getting Help<aclass="headerlink" href="#getting-help" title="Link to this heading">¶</a></h2>
117
+
<p>If you have any questions, feel free to open a discussion in the <aclass="reference external" href="https://github.com/MarkusPic/intensity_duration_frequency_analysis/discussions">GitHub Discussions</a> or comment on an open issue.</p>
118
+
</section>
119
+
<sectionid="ground-rules">
120
+
<h2>Ground Rules<aclass="headerlink" href="#ground-rules" title="Link to this heading">¶</a></h2>
121
+
<p>The goal is to maintain a diverse community that’s pleasant for everyone.
122
+
<strong>Please be considerate and respectful of others</strong>. Everyone must abide by our
123
+
<aclass="reference external" href="https://github.com/MarkusPic/intensity_duration_frequency_analysis/blob/main/CODE_OF_CONDUCT.md">Code of Conduct</a>
124
+
and we encourage all to read it carefully.</p>
125
+
</section>
126
+
<sectionid="miscellaneous">
127
+
<h2>Miscellaneous<aclass="headerlink" href="#miscellaneous" title="Link to this heading">¶</a></h2>
128
+
<p>For more information on contributing to open source projects,
129
+
<aclass="reference external" href="https://opensource.guide/how-to-contribute">GitHub’s own guide</a>
130
+
is a great starting point if you are new to version control. Also, checkout the
131
+
<aclass="reference external" href="https://jrleeman.github.io/ScientificSoftwareMaintenance/">Zen of Scientific Software Maintenance</a>
132
+
for some guiding principles on how to create high quality scientific software
0 commit comments