mirror of
https://github.com/markqvist/Reticulum.git
synced 2024-11-22 13:40:19 +00:00
Compare commits
3 Commits
fc818f00f1
...
ce91c34b21
Author | SHA1 | Date | |
---|---|---|---|
|
ce91c34b21 | ||
|
e37aa5e51a | ||
|
80af0f4539 |
23
Contributing.md
Normal file
23
Contributing.md
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
# Contributing to Reticulum
|
||||||
|
|
||||||
|
Welcome, and thank you for your interest in contributing to Reticulum!
|
||||||
|
|
||||||
|
Apart from writing code, there are many ways in which you can contribute. Before getting started, please read these guidelines.
|
||||||
|
|
||||||
|
## Asking Questions
|
||||||
|
|
||||||
|
If you want to ask a question, do not open an issue.
|
||||||
|
|
||||||
|
Instead, ask away on the [discussions](https://github.com/markqvist/Reticulum/discussions) or on the [Reticulum Matrix channel](https://unsigned.io/contact.html#reticulum:matrix.org) at `#reticulum:matrix.org`
|
||||||
|
|
||||||
|
## Providing Feedback
|
||||||
|
|
||||||
|
Likewise, feedback, ideas and feature requests are a very welcome way to contribute, and should also be posted on the [discussions](https://github.com/markqvist/Reticulum/discussions), or on the [Reticulum Matrix channel](https://unsigned.io/contact.html#reticulum:matrix.org) at `#reticulum:matrix.org`
|
||||||
|
|
||||||
|
## Reporting Issues
|
||||||
|
|
||||||
|
If you have found a bug or issue in Reticulum, please report it on the [issue tracker](https://github.com/markqvist/Reticulum/issues).
|
||||||
|
|
||||||
|
## Writing Code
|
||||||
|
|
||||||
|
If you are interested in contributing code, fixing open issues or adding features, please coordinate the effort with the maintainer or one of the main developers first, to ensure your efforts are in alignment with the [Roadmap](./Roadmap.md) and current development focus.
|
@ -20,6 +20,7 @@ For each release cycle of Reticulum, improvements and additions from the five [P
|
|||||||
- [x] Improved roaming support on Android
|
- [x] Improved roaming support on Android
|
||||||
- [x] Add bluetooth pairing code output to rnodeconf
|
- [x] Add bluetooth pairing code output to rnodeconf
|
||||||
- [x] Add `rnid` utility with encryption, signing and Identity funcionality
|
- [x] Add `rnid` utility with encryption, signing and Identity funcionality
|
||||||
|
- [ ] Add automatic retries to all use cases of the `Request` API
|
||||||
- [ ] Updating the documentation to reflect recent changes and improvements
|
- [ ] Updating the documentation to reflect recent changes and improvements
|
||||||
- [ ] Transit traffic display in rnstatus
|
- [ ] Transit traffic display in rnstatus
|
||||||
- [ ] JSON output mode for rnstatus
|
- [ ] JSON output mode for rnstatus
|
||||||
@ -77,6 +78,7 @@ These efforts seek to broaden the universality of the Reticulum software and har
|
|||||||
These efforts aim to expand and improve the core functionality and reliability of Reticulum.
|
These efforts aim to expand and improve the core functionality and reliability of Reticulum.
|
||||||
|
|
||||||
- Improve storage persist call on local client connect/disconnect
|
- Improve storage persist call on local client connect/disconnect
|
||||||
|
- Add automatic retries to all use cases of the `Request` API
|
||||||
- Faster path invalidation on physical topography changes
|
- Faster path invalidation on physical topography changes
|
||||||
- Better path invalidation on roaming interfaces
|
- Better path invalidation on roaming interfaces
|
||||||
- Add a `Buffer` class to the API, for handling stream-like buffers over Reticulum
|
- Add a `Buffer` class to the API, for handling stream-like buffers over Reticulum
|
||||||
|
Loading…
Reference in New Issue
Block a user