diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..917465a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,36 @@ +# Contributing to olden-mail + +Contributions are welcome in a limited way: I'm not very experienced with +networking best practices, so any improvement that may increase the reliability +or robustness is very appreciated! + +Feature-wise I believe it to have everything it needs to accomplish its goal, +so if you want to add some feature please message first, or fork. + +Regarding the ergonomics, I'm not sure whether to keep it as environment +variables or flags, or potentially both. If contributing something around that, +I'd appreciate that we align first on how it should look like. + +## The objective of olden mail + +The goal of olden-mail is to connect vintage comptures to modern mail servers. + +My personal setup is using an SE/30 system 7.5.5, and a mac mini with MacOS 9 +connecting to Fastmail. That's the setup I've tested so far. + +## How to contribute + +Above All: Be nice, always. + +* Ensure the linter/formatter shows no warnings or errors +* Send patches to olden.mail@r.bdr.sh using [git-send-mail][git-send-mail] + +## Things I'd like help with + +* General code quality +* Tests +* More robust and reliable networking +* Better debugging +* Compatibility with other setups + +[git-send-mail]: http://git-send-mail.io/ |