janishutz/libreevent
1
0
Fork 0
mirror of https://github.com/janishutz/libreevent.git synced 2025-11-25 13:24:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
Janis Hutz
2024-05-24 09:50:23 +02:00
parent 284f96a42d
commit 8e127a1cb5
44 changed files with 280 additions and 229 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
website/src/contributing/code-of-conduct.md
View File

@@ -4,6 +4,6 @@ If you would like to contribute code to libreevent, we'd like you to follow the
- Any code you want to contribute should have a reason to exist, please, if you find a bug or you have any idea for what you might want to contribute, ask around on GitHub, not that you do something nobody has use for or somebody else is already working on.
- Always be polite to other developers. They spend their free-time working on this project. Even if the code is not as good as you might want it to be, don't start to offend people, give them some constructive criticism or suggestions on how they can improve it.
- All the code that you produce should in no way be harmful to the consumer. If you have a proof-of-concept for a potential exploit, we'd like you to share it with us.
- If you have code that is unfinished and you don't have the time or willingness to finish it, please open a PR as a draft and we'll mark it as up for grabs.
- Please do some testing on the code you write to make sure it works as expected. We will also do our own testing, but we expect you to have checked that everything is working as it should beforehands.
- If you have code that is unfinished, and you don't have the time or willingness to finish it, please open a PR as a draft, and we'll mark it as up for grabs.
- Please do some testing on the code you write to make sure it works as expected. We will also do our own testing, but we expect you to have checked that everything is working as it should beforehand.
- Please follow our programming style and make sure that eslint does not show any errors with the code you just wrote.

4
website/src/contributing/plugins.md
View File

@@ -1,10 +1,10 @@
# Contributing Plugins
If you wish to contribute plugins and have them accepted into the official repository then your plugin has to:
- fulfill the code layout requirements given by the linter config
- fulfil the code layout requirements given by the linter config
- follow the libreevent [design guidelines](&/contributing/design-guidelines)
- conform to our [code of conduct](&/contributing/code-of-conduct)
- not contain any immediately obvious flaws (as layed out in the code of conduct), be it in terms of security or reliability
- not contain any immediately obvious flaws (as laid out in the code of conduct), be it in terms of security or reliability
- provide all necessary files for libreevent
- offer settings if possible and necessary and a way to graphically edit them
- have extensive documentation on its usage. Once accepted into the official repos, the documentation will be added to the official documentation.