From 95024d1b28418440e4adf2513c84c5a79710aace Mon Sep 17 00:00:00 2001 From: mdecimus Date: Thu, 22 May 2025 19:39:20 +0200 Subject: [PATCH] Updated README and CONTRIBUTING --- CONTRIBUTING.md | 16 +++++++++++++++- README.md | 22 +++++++++++----------- crates/main/Cargo.toml | 2 +- 3 files changed, 27 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0d178222..17c5bcd3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,20 @@ # Contributing -When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. +## Contributions are Temporarily Limited + +Thank you for your interest in contributing to Stalwart. We appreciate the support and enthusiasm of the open-source community. However, at this stage of the project, we are **limiting the scope of external contributions**. + +Stalwart is currently **not accepting external contributions**, except for bug fixes and small, well-scoped changes. The project is approaching version 1.0, and as we move toward this milestone, development is progressing rapidly. The architecture of Stalwart is still evolving, and many internal components are subject to change. + +Due to these ongoing changes and the fast pace of development, we do not have the time or resources to thoroughly review and integrate most pull requests. Accepting broad contributions at this time could lead to confusion and unnecessary rework for both contributors and maintainers. + +While we are not accepting most code contributions, you can still support the project in meaningful ways. Reporting bugs, providing feedback, and helping test the software are all valuable forms of participation. If you encounter an issue, please open a detailed report that includes steps to reproduce the problem and any relevant logs or context. We also welcome thoughtful suggestions and questions through our issue tracker or discussion channels. + +We plan to open the project to broader contributions once we reach a stable 1.0 release. At that point, with a more mature architecture and clearer development roadmap, we will be better positioned to collaborate with the community. We will update this policy accordingly when the time comes. + +Thank you for your understanding and continued support. We’re excited about the future of Stalwart and look forward to working with the community in the near future. + +## Code of Conduct Please note we have a code of conduct, please follow it in all your interactions with the project. diff --git a/README.md b/README.md index 2bd2b0a0..eb08d971 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@   License: AGPL v3   - Documentation + Documentation

Mastodon @@ -30,7 +30,7 @@ ## Features -**Stalwart** is an open-source mail & collaboration server solution with JMAP, IMAP4, POP3, SMTP, CalDAV, CardDAV and WebDAV support and a wide range of modern features. It is written in Rust and designed to be secure, fast, robust and scalable. +**Stalwart** is an open-source mail & collaboration server with JMAP, IMAP4, POP3, SMTP, CalDAV, CardDAV and WebDAV support and a wide range of modern features. It is written in Rust and designed to be secure, fast, robust and scalable. Key features: @@ -52,10 +52,10 @@ Key features: * Inbound throttling and filtering with granular configuration rules, sieve scripting, MTA hooks and milter integration. * Distributed virtual queues with delayed delivery, priority delivery, quotas, routing rules and throttling support. * Envelope rewriting and message modification. -- **Calendar**, **Contacts** and **File Storage** server: - - [CalDAV](https://datatracker.ietf.org/doc/html/rfc4791) server for calendar and scheduling. - - [CardDAV](https://datatracker.ietf.org/doc/html/rfc6352) server for contact management. - - [WebDAV](https://datatracker.ietf.org/doc/html/rfc4918) server for file storage and sharing. +- **Collaboration** server: + - Calendar and scheduling with [CalDAV](https://datatracker.ietf.org/doc/html/rfc4791). + - Contact management with [CardDAV](https://datatracker.ietf.org/doc/html/rfc6352). + - File storage and sharing with [WebDAV](https://datatracker.ietf.org/doc/html/rfc4918). - **Spam** and **Phishing** built-in filter: - Comprehensive set of filtering **rules** on par with popular solutions. - LLM-driven spam filtering and message analysis. @@ -123,18 +123,18 @@ Key features: Install Stalwart on your server by following the instructions for your platform: -- [Linux / MacOS](https://stalw.art/docs/install/linux) -- [Windows](https://stalw.art/docs/install/windows) -- [Docker](https://stalw.art/docs/install/docker) +- [Linux / MacOS](https://stalw.art/docs/install/install/llinux) +- [Windows](https://stalw.art/docs/install/install/lwindows) +- [Docker](https://stalw.art/docs/install/install/ldocker) -All documentation is available at [stalw.art/docs/get-started](https://stalw.art/docs/get-started). +All documentation is available at [stalw.art/docs/install/get-started](https://stalw.art/docs/install/get-started). ## Support If you are having problems running Stalwart, you found a bug or just have a question, do not hesitate to reach us on [GitHub Discussions](https://github.com/stalwartlabs/stalwart/discussions), [Reddit](https://www.reddit.com/r/stalwartlabs) or [Discord](https://discord.gg/aVQr3jF8jd). -Additionally you may purchase an [premium support](https://stalw.art/support) to obtain priority support from Stalwart Labs LLC. +Additionally you may purchase an [Enterprise License](https://stalw.art/enterprise) to obtain priority support from Stalwart Labs LLC. ## Sponsorship diff --git a/crates/main/Cargo.toml b/crates/main/Cargo.toml index 667f5421..f7a46046 100644 --- a/crates/main/Cargo.toml +++ b/crates/main/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "stalwart" -description = "Stalwart and Collaboration Server" +description = "Stalwart Mail and Collaboration Server" authors = [ "Stalwart Labs Ltd. "] repository = "https://github.com/stalwartlabs/stalwart" homepage = "https://stalw.art"