From 1c197f716acacfb3c914e70dbee862e8b5b790cf Mon Sep 17 00:00:00 2001 From: Jan Tojnar Date: Sun, 21 Jul 2024 02:55:45 +0200 Subject: [PATCH] docs: clarify project status MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Having read Hintjens’s Social Architecture book, I want to try to build a community around selfoss, so that I am not the sole developer forever. Until then, I need to document the current state so that people do not expect more than I have the capacity to provide. --- CONTRIBUTING.md | 6 +++++- README.md | 6 ++++++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eeca34c3c9..3178fba29c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,13 +2,17 @@ ## Reporting an issue -If you discover a bug or wish to have a feature added, [report it to the issue tracker](https://github.com/fossar/selfoss/issues/new). Try to describe the problem in as much detail as possible. +If you discover a bug, please [report it to the issue tracker](https://github.com/fossar/selfoss/issues/new). Try to describe the problem in as much detail as possible. + +You can also ask for a new feature but unless I would personally use it, I will probably not find time to implement it. ## Contributing code We accept [pull requests](https://github.com/fossar/selfoss/compare) with your changes. +For larger changes, please discuss it in an issue first, to avoid potentially wasting effort. + Every patch is expected to adhere to our coding style, which is checked automatically by CI. You can install the checkers locally using `npm run install-dependencies`, and then run the checks using `npm run check` before submitting a pull request. There is also `npm run fix`, that will attempt to fix the formatting. Please try to make commits small and self-contained. If you need to tweak something you previously committed, squash the new changes into the original commit before the PR is merged. `git commit --fixup` and `git rebase --autosquash` will help you, see https://dev.to/koffeinfrei/the-git-fixup-workflow-386d. diff --git a/README.md b/README.md index 3a2c85771b..b602a03789 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,12 @@ selfoss is a multipurpose RSS reader and feed aggregation web application. It al For more information visit our [web site](https://selfoss.aditu.de). + +## Status + +selfoss is currently maintained by Jan Tojnar in his free time. Due to the [limited capacity](https://github.com/jtojnar/jtojnar), maintenance is prioritized over new features. Pull requests are welcome, see the [Contributing](CONTRIBUTING.md) guide. + + ## Download * [Stable releases](https://github.com/fossar/selfoss/releases) – if you just want to use selfoss.