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: .github/ISSUE_TEMPLATE/bug_report.md
+2
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,8 @@ assignees: ''
7
7
8
8
---
9
9
10
+
# WARNING: Filling out the template below is NOT optional. Issues not filling out this template will be closed without review.
11
+
10
12
FIRST: Before reporting any bug, make sure that the bug you are reporting has not been reported before. Also, try to use the [nightly version](https://www.sdrpp.org/nightly) if possible in case I've already fixed the bug.
**I DO NOT ACCEPT PULL-REQUEST FOR FEATURES OR BUGFIXES REQUIRING SIGNIFICANT CODE/STRUCTURE CHANGES.**
4
-
**SUCH PULL REQUESTS WILL BE CLOSED AUTOMATICALLY. OPEN AN ISSUE DETAILING FEATURE REQUESTS OR POTENTIAL BUGFIX INSTEAD.**
5
-
6
-
# Code Style
7
-
8
-
## Naming Convention
9
-
10
-
- Files: `snake_case.h``snake_case.cpp`
11
-
- Namespaces: `CamelCase`
12
-
- Classes: `CamelCase`
13
-
- Structs: `CamelCase_t`
14
-
- Members: `camelCase`
15
-
- Enum: `SNAKE_CASE`
16
-
- Macros: `SNAKE_CASE`
17
-
18
-
## Brace Style
19
-
20
-
```c++
21
-
intmyFunction() {
22
-
if (shortIf) { shortFunctionName(); }
23
-
24
-
if (longIf) {
25
-
longFunction();
26
-
otherStuff();
27
-
myLongFunction();
28
-
}
29
-
}
30
-
```
31
-
32
-
Note: If it makes the code cleaner, remember to use the `?` keyword instead of a `if else` statement.
33
-
34
-
## Pointers
35
-
36
-
Please use `type* name` for pointers.
37
-
38
-
## Structure
39
-
40
-
Headers and their associated C++ files shall be in the same directory. All headers must use `#pragma once` instead of other include guards. Only include files in a header that are being used in that header. Include the rest in the associated C++ file.
41
-
42
-
# Modules
43
-
44
-
## Module Naming Convention
45
-
46
-
All modules names must be `snake_case`. If the module is a source, it must end with `_source`. If it is a sink, it must end with `_sink`.
47
-
48
-
For example, lets take the module named `cool_source`:
49
-
50
-
- Directory: `cool_source`
51
-
- Class: `CoolSourceModule`
52
-
- Binary: `cool_source.<os dynlib extension>`
53
-
54
-
## Integration into main repository
55
-
56
-
If the module meets the code quality requirements, it may be added to the official repository. A module that doesn't require any external dependencies that the core doesn't already use may be enabled for build by default. Otherwise, they must be disabled for build by default with a `OPT_BUILD_MODULE_NAME` variable set to `OFF`.
57
-
58
-
# JSON Formatting
59
-
60
-
The ability to add new radio band allocation identifiers and color maps relies on JSON files. Proper formatting of these JSON files is important for reference and readability. The following guides will show you how to properly format the JSON files for their respective uses.
61
-
62
-
**IMPORTANT: JSON File cannot contain comments, there are only in this example for clarity**
3
+
Code pull requests are **NOT welcome**. Please open an issue discussing potential bugfixes or feature requests instead.
63
4
64
5
## Band Frequency Allocation
65
6
@@ -119,8 +60,8 @@ Please follow this guide to properly format the JSON files for custom color maps
119
60
}
120
61
```
121
62
122
-
# Best Practices
63
+
# JSON Formatting
64
+
65
+
The ability to add new radio band allocation identifiers and color maps relies on JSON files. Proper formatting of these JSON files is important for reference and readability. The following guides will show you how to properly format the JSON files for their respective uses.
123
66
124
-
* All additions and/or bug fixes to the core must not add additional dependencies.
125
-
* Use VSCode for development, VS seems to cause issues.
126
-
* DO NOT use libboost for any code meant for this repository
67
+
**IMPORTANT: JSON File cannot contain comments, there are only in this example for clarity**
0 commit comments