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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+19-1Lines changed: 19 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,8 @@
13
13
14
14
Debugging:
15
15
16
-
- Run **Debug Profile** in Visual Studio or **Run Configuration** in JetBrains Rider. The required files have been added. All project files will be automatically copied to the Revit plugins folder.
16
+
- Run **Debug Profile** in Visual Studio or **Run Configuration** in JetBrains Rider. The required files have been
17
+
added. All project files will be automatically copied to the Revit plugins folder.
17
18
18
19
Creating a package:
19
20
@@ -23,6 +24,23 @@ Creating a package:
23
24
- The generated package will be in the **output** folder.
24
25
25
26
---
27
+
28
+
### Documentation and comments
29
+
30
+
- Document your code write with English language and use [Jupyter Book](https://jupyterbook.org/en/stable/intro.html) to
31
+
generate the documentation. Please use branch.
32
+
**docs** to collaborate with the documentation.
33
+
34
+
### Unit tests
35
+
36
+
- The [Revit Test Framework](https://github.com/DynamoDS/RevitTestFramework) (RTF) allows for remote testing on Revit.
37
+
RTF creates a journal file for running Revit, specifies a model for it to open, and a specific test or fixture of
38
+
tests to run. A model can also be specified to open before testing to run several tests with.
39
+
- Write unit tests for your code. Please use branch **dev** to collaborate with the tests and write them in the
0 commit comments