mirror of
https://github.com/markqvist/Reticulum.git
synced 2026-04-27 14:20:35 +00:00
58 lines
4.5 KiB
Markdown
58 lines
4.5 KiB
Markdown
# 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 interacting with this community, read these short and simple guidelines.
|
|
|
|
## Expected Conduct
|
|
|
|
First and foremost, there is one simple requirement for taking part in this community: While we primarily interact virtually, your actions matter and have real consequences. Therefore: **Act like a responsible, civilized person** - especially in the face of disputes and heated disagreements. Speak your mind here; discussions are welcome. Just do so in the spirit of being face-to-face with everyone else. Thank you.
|
|
|
|
In order to keep the discussion forums and issue trackers navigable and useful, the following types of posts will be deleted without notice:
|
|
|
|
- Spam.
|
|
- Questions that have already been adequately answered elsewhere. Use the search function.
|
|
- Low-effort posts or comments that contain no actual information or useful content. This is not a tea-house.
|
|
- Post or comments solely containing personal opinions or beliefs without adding anything to the discussion. Facebook and X exists.
|
|
- Content that simply waste the developer's / maintainer's time with completely obvious "ideas", "insights" or "recommendations". Yes, we have *at least* 8 neurons ourselves.
|
|
- Posts that fail to understand that developing a highly complex software project with a very small amount of resources and people takes time. Imagining perfection on our behalf is useless.
|
|
|
|
If you're new to the community and start out your engagement with any of the above transgressions, you will simply be banned without notice or explanation, and your post will be deleted.
|
|
|
|
If you find this "harsh", "unfair" or "unwelcoming", go somewhere else. This is not social club, but a work environment for the people contributing to the project.
|
|
|
|
## Asking Questions
|
|
|
|
If you want to ask a question, **do not open an issue**. The issue tracker is used by people *working on Reticulum* to track bugs, issues and improvements. Instead, ask away on the [discussions](https://github.com/markqvist/Reticulum/discussions).
|
|
|
|
Do not post feature requests or general ideas on the issue tracker, or in direct messages to the primary developers. You are much more likely to get a response and start a constructive discussion by posting your ideas in the public channels created for these purposes.
|
|
|
|
## Reporting Issues
|
|
|
|
If you have found a bug or issue in this project, please report it using the [issue tracker](https://github.com/markqvist/Reticulum/issues). Be sure to include details on how to reproduce the bug.
|
|
|
|
Anything submitted to the issue tracker that does not follow these guidelines will be closed and removed without comments or explanation.
|
|
|
|
## 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 **before** submitting a pull request. Before deciding to contribute, it is also a good idea to ensure your efforts are in alignment with the [Roadmap](./Roadmap.md) and current development focus.
|
|
|
|
Pull requests have a high chance of being accepted if they are:
|
|
|
|
- In alignment with the [Roadmap](./Roadmap.md) or solve an open issue or feature request
|
|
- Sufficiently tested to work with all API functions, and pass the standard test suite
|
|
- Functionally and conceptually complete and well-designed
|
|
- Not simply formatting or code style changes
|
|
- Well-documented
|
|
|
|
Even new ideas and proposals that have not been approved by a maintainer, or fall outside the established roadmap, are *occasionally* accepted - if they possess the remaining of the above qualities. If not, they will be closed and removed without comments or explanation.
|
|
|
|
## Generative AI Policy
|
|
|
|
Contributions written using large language models (LLMs) or other generative 'AI' programs are prohibited. LLMs produce errors so frequently and in a way that is so unlike human error that such issues are incredibly time-consuming to spot and fix. This is not a worthwhile tradeoff for Reticulum.
|
|
|
|
This applies to all Reticulum-related projects and documentation, as well as all submitted issues and discussion in official channels, except in cases where language translation and/or speech recogntion technologies are required for communication.
|
|
|
|
## Contributor License Agreement
|
|
|
|
By contributing code to this project, you agree that copyright for the code is transferred to the Reticulum maintainers and that the code is irrevocably placed under the [Reticulum License](./LICENSE).
|