diff --git a/owl/README.md b/owl/README.md index bac19b41..aa4744ba 100644 --- a/owl/README.md +++ b/owl/README.md @@ -12,15 +12,25 @@ In this owl folder should go all documents we produce for this Endeavour. ## Goals - - Find a way to build extensions that survive upstream merges best. This means, reduce contact point, create own files, even be in own folder if possible. This needs a thorough scan of the codebase. - - We will try to integrate `comms` project at some point. but this is a separate task, not needed yet. It will bring voice server to the rooms. comms uses a wasm system. - - Try to find out how much we can change behaviour of the page with the _themes_ (skins) only. Some small silly things, like that reacting with a new emoji on a post should not be on the left side of a message, where currently it is embedded in a popup. - - Find out how we can set that Twitter Emojis are standard - system emojis on windows are terrible. - - Find out how we can set a theme by default for new users. - - img tags in messages should be rendered, without requiring them to be on a local cache. We do not need to secure against identification attacks. - - youtube links should create embedded players (if enabled). + - [x] Find a way to build extensions that survive upstream merges best. This means, reduce contact point, create own files, even be in own folder if possible. This needs a thorough scan of the codebase. + - [ ] We will try to integrate `comms` project at some point. but this is a separate task, not needed yet. It will bring voice server to the rooms. comms uses a wasm system. + - [x] Try to find out how much we can change behaviour of the page with the _themes_ (skins) only. Some small silly things, like that reacting with a new emoji on a post should not be on the left side of a message, where currently it is embedded in a popup. + - [x] Find out how we can set that Twitter Emojis are standard - system emojis on windows are terrible. + - [x] Find out how we can set a theme by default for new users. + - [x] img tags in messages should be rendered, without requiring them to be on a local cache. We do not need to secure against identification attacks. + - [ ] youtube links should create embedded players (if enabled). + - [ ] 9gag links with videos should allow them to be played if possible on demand. + +## Commit Messages - ## Commit Messages - - All Commits for OWL changes start with the Owl Emoji 🦉 + - All Commits for OWL changes start with the Owl Emoji 🦉 + - I do most commits as user + +## Code Guidelines + + - This Repository follows the official cinny repo, but represents a custom modification. + - This means we have to keep Upstream Codebase mergable easy + - This means: /src/owl/ is the local override folder, longer implementations and definitions go + - Only required wirings, imports or unavoidable modifications should be in the main source code. + - Learn from owl commits