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
Contributions are welcome, and they are greatly appreciated! Every little bit
4
+
helps, and credit will always be given.
5
+
6
+
## Types of Contributions
7
+
8
+
### Report Bugs
9
+
10
+
If you are reporting a bug, please include:
11
+
12
+
* Your operating system name and version.
13
+
* Any details about your local setup that might be helpful in troubleshooting.
14
+
* Detailed steps to reproduce the bug.
15
+
16
+
### Fix Bugs
17
+
18
+
Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
19
+
wanted" is open to whoever wants to implement it.
20
+
21
+
### Implement Features
22
+
23
+
Look through the GitHub issues for features. Anything tagged with "enhancement"
24
+
and "help wanted" is open to whoever wants to implement it.
25
+
26
+
### Write Documentation
27
+
28
+
You can never have enough documentation! Please feel free to contribute to any
29
+
part of the documentation, such as the official docs, docstrings, or even
30
+
on the web in blog posts, articles, and such.
31
+
32
+
### Submit Feedback
33
+
34
+
If you are proposing a feature:
35
+
36
+
* Explain in detail how it would work.
37
+
* Keep the scope as narrow as possible, to make it easier to implement.
38
+
* Remember that this is a volunteer-driven project, and that contributions
39
+
are welcome :)
40
+
41
+
## Get Started!
42
+
43
+
Ready to contribute? Here's how to set up `static_scenario_generator` for local development.
44
+
45
+
1. Download a copy of `static_scenario_generator` locally.
46
+
2. Install `static_scenario_generator` using `poetry`:
47
+
48
+
```console
49
+
$ poetry install
50
+
```
51
+
52
+
3. Use `git` (or similar) to create a branch for local development and make your changes:
53
+
54
+
```console
55
+
$ git checkout -b name-of-your-bugfix-or-feature
56
+
```
57
+
58
+
4. Create an issue, unless one exists.
59
+
60
+
5. When you're done making changes, check that your changes conform to any code formatting requirements and pass any tests.
61
+
62
+
6. Commit your changes and open a pull request.
63
+
64
+
7. Link pull request to open issue. Github provides a helpful [guide](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)
65
+
66
+
## Pull Request Guidelines
67
+
68
+
Before you submit a pull request, check that it meets these guidelines:
69
+
70
+
1. The pull request should include additional tests if appropriate.
71
+
2. If the pull request adds functionality, the docs should be updated.
72
+
3. The pull request should work for all currently supported operating systems and versions of Python.
<h1>Contributing<aclass="headerlink" href="#contributing" title="Link to this heading"></a></h1>
94
+
<p>Contributions are welcome, and they are greatly appreciated! Every little bit
95
+
helps, and credit will always be given.</p>
96
+
<sectionid="types-of-contributions">
97
+
<h2>Types of Contributions<aclass="headerlink" href="#types-of-contributions" title="Link to this heading"></a></h2>
98
+
<sectionid="report-bugs">
99
+
<h3>Report Bugs<aclass="headerlink" href="#report-bugs" title="Link to this heading"></a></h3>
100
+
<p>If you are reporting a bug, please include:</p>
101
+
<ulclass="simple">
102
+
<li><p>Your operating system name and version.</p></li>
103
+
<li><p>Any details about your local setup that might be helpful in troubleshooting.</p></li>
104
+
<li><p>Detailed steps to reproduce the bug.</p></li>
105
+
</ul>
106
+
</section>
107
+
<sectionid="fix-bugs">
108
+
<h3>Fix Bugs<aclass="headerlink" href="#fix-bugs" title="Link to this heading"></a></h3>
109
+
<p>Look through the GitHub issues for bugs. Anything tagged with “bug” and “help
110
+
wanted” is open to whoever wants to implement it.</p>
111
+
</section>
112
+
<sectionid="implement-features">
113
+
<h3>Implement Features<aclass="headerlink" href="#implement-features" title="Link to this heading"></a></h3>
114
+
<p>Look through the GitHub issues for features. Anything tagged with “enhancement”
115
+
and “help wanted” is open to whoever wants to implement it.</p>
116
+
</section>
117
+
<sectionid="write-documentation">
118
+
<h3>Write Documentation<aclass="headerlink" href="#write-documentation" title="Link to this heading"></a></h3>
119
+
<p>You can never have enough documentation! Please feel free to contribute to any
120
+
part of the documentation, such as the official docs, docstrings, or even
121
+
on the web in blog posts, articles, and such.</p>
122
+
</section>
123
+
<sectionid="submit-feedback">
124
+
<h3>Submit Feedback<aclass="headerlink" href="#submit-feedback" title="Link to this heading"></a></h3>
125
+
<p>If you are proposing a feature:</p>
126
+
<ulclass="simple">
127
+
<li><p>Explain in detail how it would work.</p></li>
128
+
<li><p>Keep the scope as narrow as possible, to make it easier to implement.</p></li>
129
+
<li><p>Remember that this is a volunteer-driven project, and that contributions
130
+
are welcome :)</p></li>
131
+
</ul>
132
+
</section>
133
+
</section>
134
+
<sectionid="get-started">
135
+
<h2>Get Started!<aclass="headerlink" href="#get-started" title="Link to this heading"></a></h2>
136
+
<p>Ready to contribute? Here’s how to set up <codeclass="docutils literal notranslate"><spanclass="pre">static_scenario_generator</span></code> for local development.</p>
137
+
<olclass="arabic">
138
+
<li><p>Download a copy of <codeclass="docutils literal notranslate"><spanclass="pre">static_scenario_generator</span></code> locally.</p></li>
139
+
<li><p>Install <codeclass="docutils literal notranslate"><spanclass="pre">static_scenario_generator</span></code> using <codeclass="docutils literal notranslate"><spanclass="pre">poetry</span></code>:</p>
<li><p>Use <codeclass="docutils literal notranslate"><spanclass="pre">git</span></code> (or similar) to create a branch for local development and make your changes:</p>
<li><p>Create an issue, unless one exists.</p></li>
150
+
<li><p>When you’re done making changes, check that your changes conform to any code formatting requirements and pass any tests.</p></li>
151
+
<li><p>Commit your changes and open a pull request.</p></li>
152
+
<li><p>Link pull request to open issue. Github provides a helpful <aclass="reference external" href="https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue">guide</a></p></li>
153
+
</ol>
154
+
</section>
155
+
<sectionid="pull-request-guidelines">
156
+
<h2>Pull Request Guidelines<aclass="headerlink" href="#pull-request-guidelines" title="Link to this heading"></a></h2>
157
+
<p>Before you submit a pull request, check that it meets these guidelines:</p>
158
+
<olclass="arabic simple">
159
+
<li><p>The pull request should include additional tests if appropriate.</p></li>
160
+
<li><p>If the pull request adds functionality, the docs should be updated.</p></li>
161
+
<li><p>The pull request should work for all currently supported operating systems and versions of Python.</p></li>
162
+
<li><p>The pull request should be linked to an issue.</p></li>
0 commit comments