Skip to content

Commit cae5caa

Browse files
phretorphretor
committed
- Code of conduct
- Contributing guidelines - Security policy - Issue templates Signed-off-by: Federico Maggi <[email protected]>
1 parent 76062b3 commit cae5caa

File tree

6 files changed

+221
-0
lines changed

6 files changed

+221
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
name: Bug report
3+
about: Create a bug report
4+
title: ''
5+
labels: ["Bug"]
6+
assignees: ''
7+
8+
---
9+
10+
**IMPORTANT:** Check the README, issues, discussions, and Discord!
11+
12+
Before submitting new issue, please check the [issues](https://github.com/rfquack/RFQuack/issues) the [Discussions](https://github.com/rfquack/RFQuack/discussions), and our [Discord](https://discord.gg/6c8hcGbdc5). You might find a solution to your issue there.
13+
14+
## Describe the bug
15+
16+
A clear and concise description of what the bug is. When applicable, please include relevant output (no screenshots, if possible!), [verbose logging](https://github.com/rfquack/RFQuack/blob/master/src/config/logging.h), and [RadioLib debug mode output](https://github.com/jgromes/RadioLib/wiki/Debug-mode).
17+
18+
## To Reproduce
19+
20+
Minimal build steps or PlatformIO project to reproduce the behavior (feel free to use our [examples](https://github.com/rfquack/RFQuack/tree/master/examples) as a starting point). Please use Markdown to style the code to make it readable (see [Markdown Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#code)).
21+
22+
## Expected behavior
23+
24+
A clear and concise description of what you expected to happen.
25+
26+
## Screenshots or pictures
27+
28+
If applicable, add screenshots or pictures (e.g., to show wiring) to help explain your problem.
29+
30+
## Additional info (please complete)
31+
32+
- MCU: [e.g., ESP32, ESP8266 etc.]
33+
- Wireless module type [e.g., CC1101, SX1268, etc.]
34+
- Host environment [e.g., Docker, Linux, macOS, Windows]
35+
- RFQuack version, branch, or tag [e.g., master]
36+
- RadioLib version, branch, or tag [e.g., v.5.3.0]

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
name: Feature request
3+
about: Create a feature request
4+
title: ''
5+
labels: ["Feature request"]
6+
assignees: ''
7+
8+
---
9+
10+
**IMPORTANT:** Check the README, issues, discussions, and Discord!
11+
12+
Before submitting new feature request, please check the [issues](https://github.com/rfquack/RFQuack/issues) the [Discussions](https://github.com/rfquack/RFQuack/discussions), and our [Discord](https://discord.gg/6c8hcGbdc5). You might find a solution to your issue there.
13+
14+
## Describe the bug
15+
16+
A clear and concise description of what the bug is. When applicable, please include relevant output (no screenshots, if possible!), [verbose logging](https://github.com/rfquack/RFQuack/blob/master/src/config/logging.h), and [RadioLib debug mode output](https://github.com/jgromes/RadioLib/wiki/Debug-mode).
17+
18+
## To Reproduce
19+
20+
Minimal build steps or PlatformIO project to reproduce the behavior (feel free to use our [examples](https://github.com/rfquack/RFQuack/tree/master/examples) as a starting point). Please use Markdown to style the code to make it readable (see [Markdown Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#code)).
21+
22+
## Expected behavior
23+
24+
<!--A clear and concise description of what you expected to happen.-->
25+
26+
## Screenshots or pictures
27+
28+
<!--If applicable, add screenshots or pictures (e.g., to show wiring) to help explain your problem.-->
29+
30+
## Additional info (please complete)
31+
32+
- MCU: [e.g., ESP32, ESP8266 etc.]
33+
- Wireless module type [e.g., CC1101, SX1268, etc.]
34+
- Host environment [e.g., Docker, Linux, macOS, Windows]
35+
- RFQuack version, branch, or tag [e.g., master]
36+
- RadioLib version, branch, or tag [e.g., v.5.3.0]

‎.github/ISSUE_TEMPLATE/vulnerability.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
name: Vulnerability
3+
about: Create a security vulnerability report
4+
title: '[VULN] '
5+
labels: ["Vulnerability"]
6+
assignees: ''
7+
8+
---
9+
10+
**IMPORTANT:** Check the README, issues, discussions, and Discord!
11+
12+
Before submitting new vulnerability, please check the existing [issues](https://github.com/rfquack/RFQuack/issues) the [Discussions](https://github.com/rfquack/RFQuack/discussions), and our [Discord](https://discord.gg/6c8hcGbdc5). You might find a solution to your issue there.
13+
14+
## High-level overview of the vulnerability and the possible effect of using it
15+
16+
<!-- A clear and concise description of what the vulnerability is about. -->
17+
18+
## Detailed description of the vulnerability
19+
20+
<!-- Describe the details of the vulnerability (e.g., code line, code path) -->
21+
22+
## How did you find this vulnerability?
23+
24+
<!-- Describe the tools and/or proceure you used to find the vulnerability (e.g., grep) -->
25+
26+
## Can you identify exploitability?
27+
28+
<!-- Tell us whether you think this is exploitable or not -->
29+
30+
## Can you identify root cause?
31+
32+
<!-- Please justify why the code you highlighted creates the venue for a vulnerability -->
33+
34+
## Version information and any specific configuration/hardware requirements
35+
36+
<!-- Commit hash, branch, tag -->

‎CODE_OF_CONDUCT.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Code of Conduct
2+
3+
The RFQuack community is dedicated to providing a harassment-free environment for all, regardless of gender, sexual orientation, disability, physical appearance, body size, race, or religion. We do not tolerate harassment of any form. All communication should be appropriate for a professional audience including people of many different backgrounds.
4+
5+
Sexual language and imagery is not appropriate for any communication and/or talks. Be kind and do not insult or put down others. Behave professionally. Remember that harassment and sexist, racist, or exclusionary jokes are not appropriate for the RFQuack community. Members violating these rules should be reported to the project maintainers.
6+
7+
These are the values to which people in the RFQuack community should aspire:
8+
9+
- Be friendly and welcoming
10+
- Be patient
11+
- Remember that people have varying communication styles and that not everyone is using their native language. (Meaning and tone can be lost in translation.)
12+
- Be thoughtful
13+
- Productive communication requires effort. Think about how your words will be interpreted.
14+
- Remember that sometimes it is best to refrain entirely from commenting.
15+
- Be respectful
16+
- In particular, respect differences of opinion.
17+
- Be charitable
18+
- Interpret the arguments of others in good faith, do not seek to disagree.
19+
- When we do disagree, try to understand why.
20+
- Avoid destructive behavior:
21+
- Derailing: stay on topic; if you want to talk about something else, start a new conversation.
22+
- Non-constructive criticism: don't merely decry the current state of affairs; offer—or at least solicit—suggestions as to how things may be improved.
23+
- Snarking (pithy, unproductive, sniping comments)
24+
- Discussing potentially offensive or sensitive issues; this all too often leads to unnecessary conflict.
25+
- Microaggressions: brief and commonplace verbal, behavioral and environmental indignities that communicate hostile, derogatory or negative slights and insults to a person or group.
26+
27+
People are complicated. You should expect to be misunderstood and to misunderstand others; when this inevitably occurs, resist the urge to be defensive or assign blame. Try not to take offense where no offense was intended. Give people the benefit of the doubt. Even if the intent was to provoke, do not rise to it. It is the responsibility of all parties to de-escalate conflict when it arises.
28+
29+
## Attribution
30+
31+
This Code of Conduct was adapted from this [code of conduct template](https://gist.github.com/Integralist/4e84af31c483d0f5a182).

‎CONTRIBUTING.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Contributing to RFQuack
2+
3+
- [Contributing to RFQuack](#contributing-to-rfquack)
4+
- [Code of Conduct](#code-of-conduct)
5+
- [Issues](#issues)
6+
- [Code style guidelines](#code-style-guidelines)
7+
8+
First of all, thank you very much for taking the time to contribute! All feedback and ideas are greatly appreciated.
9+
To keep this library organized, please follow these guidelines.
10+
11+
**Credits:** Given the tight coupling between RFQuack and [RadioLib](https://gituhb.com/jgromes/RadioLib), these contributing guidelines as well as the issue templates are based on RadioLib's.
12+
13+
## Code of Conduct
14+
15+
Please read through our community [Code of Conduct](https://github.com/rfquack/RFQuack/blob/master/CODE_OF_CONDUCT.md).
16+
17+
## Issues
18+
19+
The following rules guide submission of new issues. These rules are in place mainly so that the issue author can get help as quickly as possible.
20+
21+
1. **Questions are welcome, spam is not.**
22+
Any issues without description will be considered spam and as such will be **CLOSED** and **LOCKED** immediately!
23+
2. **This repository has issue templates.**
24+
To report bugs or suggest new features, use the provided issue templates. Use the default issue only if the templates do not fit your issue type.
25+
3. **Be as clear as possible when creating issues.**
26+
Issues with generic titles (e.g. "not working", "lora", etc.) will be **CLOSED** until the title is fixed, since the title is supposed to categorize the issue. The same applies for issues with very little information and extensive grammatical or formatting errors that make it difficult to find out what is the actual issue.
27+
4. **Issues deserve some attention too.**
28+
Issues that are left for 2 weeks without response by the original author when asked for further information will be closed due to inactivity. This is to keep track of important issues, the author is encouraged to reopen the issue at a later date.
29+
30+
## Code style guidelines
31+
32+
I like pretty code! Or at least, I like *consistent* code style. When creating pull requests, please follow these style guidelines, they're in place to keep high code readability.
33+
34+
1. **Bracket style**
35+
This library uses the following style of bracket indentation (1TBS, or "javascript" style):
36+
37+
```c++
38+
if (foo) {
39+
bar();
40+
} else {
41+
baz();
42+
}
43+
```
44+
45+
1. **Tabs**
46+
Use 4 space characters for tabs.
47+
48+
1. **Single-line comments**
49+
Comments can be very useful and they can become the bane of readability. Every single-line comment should start at new line, have one space between comment delimiter `//` and the start of the comment itself. The comment should also start with a lower-case letter.
50+
51+
```c++
52+
// this function does something
53+
foo("bar");
54+
55+
// here it does something else
56+
foo(12345);
57+
```
58+
59+
1. **Split code into blocks**
60+
It is very easy to write code that machine can read. It is much harder to write one that humans can read. That's why it's a great idea to split code into blocks - even if the block is just a single line!
61+
62+
```c++
63+
// build a temporary buffer (first block)
64+
uint8_t* data = new uint8_t[len + 1];
65+
if(!data) {
66+
return(STATUS);
67+
}
68+
69+
// read the received data (second block)
70+
state = readData(data, len);
71+
72+
// add null terminator (third block)
73+
data[len] = 0;
74+
```
75+
76+
1. **No Arduino Strings**
77+
Arduino `String` class should never be used internally in the library. The only allowed occurrence of Arduino `String` is in public API methods, and only at the top-most layer.

‎SECURITY.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
RFQuack is provided as-is without any warranty, and is not intended to be used in security-critical applications. However, if you discover a vulnerability within the library code, please create an issue choosing the appropriate template.

0 commit comments

Comments
 (0)