|
1 | 1 | Contributing to User Tutorials |
2 | 2 | ============================== |
3 | 3 |
|
4 | | -SimPEG welcomes contributions by the community to improve available tutorial materials. |
5 | | -However, tutorials must adhere to specific guidelines in order to ensure a high level of quality and consistency. |
6 | | -For those interested in contributing to SimPEG User Tutorials, please follow the instructions provided. |
| 4 | +We greatly appreciate efforts made by the SimPEG community to improve available tutorial material. |
| 5 | +This includes: |
7 | 6 |
|
| 7 | +* improving the content within preexisting tutorials, and |
| 8 | +* adding a new tutorials |
8 | 9 |
|
9 | | -Before Creating a New Tutorial |
10 | | ------------------------------- |
| 10 | +However, tutorials must adhere to specific guidelines in order to ensure a high level of quality and consistency. |
| 11 | +Some of the things we would like to avoid are: |
11 | 12 |
|
12 | | -```{admonition} WARNING! |
13 | | -:class: danger |
14 | | -Please ensure that the contents of your tutorial **DOES NOT** fall into any of the following categories: |
| 13 | +* tutorials created for the purpose of self promotion |
| 14 | +* tutorials that focuss primarily on functionality that is not part of SimPEG |
| 15 | +* tutorials containing data-specific results, where choices in parameter values are not generally applicable |
15 | 16 |
|
16 | | -* the tutorial focusses on functionality that is not part of SimPEG |
17 | | -* the amount of SimPEG functionality NOT already covered in another tutorial is insufficient |
18 | | -* the tutorial focusses on a data-specific result and is not generalizable |
19 | | -* the tutorial was created for the purpose of self promotion |
| 17 | +For those interested in contributing to SimPEG User Tutorials, please follow the instructions provided. |
20 | 18 |
|
21 | | -Tutorials that fall into any of these categories will not be accepted! |
22 | | -``` |
23 | 19 |
|
24 | 20 | Steps for Adding a Tutorial |
25 | 21 | --------------------------- |
|
0 commit comments