From 5100d8ad6f7e026322f20da122f9cb53584a64e6 Mon Sep 17 00:00:00 2001
From: rimu <3310831+rimu@users.noreply.github.com>
Date: Wed, 6 Sep 2023 21:06:41 +1200
Subject: [PATCH] contributing and roadmap

---
 CONTRIBUTING.md |  6 ++++++
 ROADMAP.md      | 41 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 47 insertions(+)
 create mode 100644 CONTRIBUTING.md
 create mode 100644 ROADMAP.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..517b150c
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,6 @@
+# Contributing to PyFedi
+
+Please discuss your ideas in an issue at https://codeberg.org/rimu/pyfedi/issues before 
+starting any work to ensure alignment with the roadmap, architecture and processes.
+
+Mailing list, Matrix channel, etc still to come.
\ No newline at end of file
diff --git a/ROADMAP.md b/ROADMAP.md
new file mode 100644
index 00000000..bd576028
--- /dev/null
+++ b/ROADMAP.md
@@ -0,0 +1,41 @@
+# PyFedi Roadmap
+
+The following are the goals for a 1.0 release, good enough for production use. Items with a ✅  are complete.
+
+### Basic functionality
+
+- ✅ log in, register, reset password
+- ✅ browse and subscribe to communities
+- post in local community
+- comment on posts in local community
+- vote
+- sort posts by hotness algo
+- markdown
+
+
+### Activitypub-enabled
+
+- follow remote community
+- post content in remote community
+- vote
+
+### Search
+
+- content & users
+- hashtags
+- privacy controls
+
+### Moderation
+
+- community moderation
+- blocking - users, communities, domains, instances. bi-directional.
+- import/export of block lists
+
+### Onboarding
+
+- choose interests to auto-subscribe new accounts
+
+### Performance and scaling
+
+- async / await
+- threading