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
+4-2Lines changed: 4 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -54,7 +54,7 @@ A good bug report shouldn't leave others needing to chase you up for more inform
54
54
- Collect information about the bug:
55
55
- Debug information provided by the application
56
56
- GNOME: From the main hamburger menu, open About Application → Troubleshooting → Debugging Information and copy the information to the clipboard to paste in your issue.
57
-
- WinUI: From the Help item in the left-side navigation, open About -> Debugging and copy the information to the clipboard to paste in your issue.
57
+
- WinUI: From the Help item in the left-side navigation, open About Application --> Debugging and copy the information to the clipboard to paste in your issue.
58
58
- Stack trace (Traceback)
59
59
- Including any error messages thrown by the application
60
60
- You may need to start the application via the terminal/console to receive an error message for a crash.
@@ -140,6 +140,7 @@ The whole project utilizes the [MVC](https://en.wikipedia.org/wiki/Model%E2%80%9
140
140
141
141
This project contains all of the code used by all platforms of the app:
142
142
-`controllers` => The objects used by UI views to receive and manipulate data from the models.
143
+
-`events` => Arguments that are used by events throughout the application.
143
144
-`helpers` => Useful objects and functions specific to the application that can be used by all platforms.
144
145
-`models` => The data driven objects of the application (i.e. Configuration, Database, etc...).
145
146
@@ -158,7 +159,7 @@ This project contains all of the code used for the GNOME platform version of the
158
159
This project contains all of the code used for the WinUI platform version of the app:
159
160
-`controls` => Generic controls for the app.
160
161
- These UI objects are separate from views in that they should not be backed by a controller and should be easily ported to any other app.
161
-
-`helpers` => Useful objects and functions specific for the Qt platform version of the app.
162
+
-`helpers` => Useful objects and functions specific for the WinUI platform version of the app.
162
163
-`views` => The views (pages, windows, dialogs, etc...) of the app.
163
164
164
165
#### Developing and Testing
@@ -173,6 +174,7 @@ Application uses the following naming conventions:
173
174
-`CamelCase` for namespaces and classes
174
175
-`pascalCase` for file names, functions, and variables
175
176
-`m_` prefix appended to class member variables
177
+
-`s_` prefix appended to global static variables
176
178
-`get` and `set` prefixes used for accessor and modifiers methods of a class variable respectively
177
179
- Exception: For boolean class members, `is` and `setIs` should be used as the prefixes for the accessor and modifier methods of said members.
0 commit comments