Skip to content

Commit fa76b4e

Browse files
Made the contributing policy more clear
1 parent 0521679 commit fa76b4e

File tree

2 files changed

+6
-68
lines changed

2 files changed

+6
-68
lines changed

.github/pull_request_template.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
11
# Important
22

3-
Only minor bug fixes and bandplans are accepted.
4-
5-
Pull requests adding features or any bug fix that requires significant code changes will be automatically rejected.
6-
3+
Only bandplan, colormaps and themes are accepted. Code pull requests are **NOT welcome**.
74
Open an issue requesting a feature or discussing a possible bugfix instead.

contributing.md

Lines changed: 5 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,6 @@
11
# Pull Requests
22

3-
**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-
int myFunction() {
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.
634

645
## Band Frequency Allocation
656

@@ -119,8 +60,8 @@ Please follow this guide to properly format the JSON files for custom color maps
11960
}
12061
```
12162

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.
12366

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

Comments
 (0)