Our goal is to make BookWyrm a kind and welcoming place where everyone can contribute to the success of the project.
Ensure you are aware of and agree to our Code of Conduct.
Please note that the BookWyrm project is licensed under the Anti-capitalist Software License. This license will apply to any contributions you make.
Meaningful human interaction is the whole point of BookWyrm. We do not accept AI-generated code or documentation. If you are unsure how something in BookWyrm works, please ask for help – we are keen to help other humans to understand and contribute to the project.
If you have a question or suggestion about anything to do with BookWyrm, the best place for a quick response is our Matrix chat room.
If you are a maintainer of a BookWyrm server (aka "instance"), you can also ask to join the additional Matrix chat room specifically for instance admins.
You can create a GitHub issue to improve our documentation, or to report a bug or request a new feature in the main project.
There are many ways you can contribute to this project, regardless of your technical or coding expertise.
We want BookWyrm to be a fun experience that is intuitive to understand. If you're confused by something, it's probably because it is confusing! You can help improve our documentation and Guided Tour as well as the platform itself.
You can report bugs by clicking "New Issue". The more information you can provide, the easier it will be to understand the problem and squash that bug!
It's a good idea to search the Issues for key words associated with your bug first because someone else may have already reported it.
Got a great idea for an improvement to BookWyrm? You can request new features by clicking "New Issue".
It's a good idea to search the Issues for key words associated with your feature suggestion first because someone else may have already requested it.
Bibliographic metadata wizard? Celery nerd? ActivityPub expert? SQL query obsessive? We need all kinds of expertise! You can contribute to discussions in the Issues or reach out to make suggestions in our Matrix chat room or via an Issue of your own.
Codebeiträge sind herzlich willkommen! Wenn du nicht weißt, wo du anfangen sollst, schau dir das "Good first issue"-Tag an. Because BookWyrm is a small project, there isn't a lot of formal structure, but there is a capacity for one-on-one support, which can look like asking questions as you go, pair programming, video chats, et cetera, so please feel free to reach out.
Check out the Guide to the developer environment and our code style guide.
Good documentation is crucial so that people know how to use, contribute to, and administer BookWyrm. No matter how you are involved with BookWyrm, your perspective is valuable and you can contribute to our documentation. Find out more about how you can contribute to the docs.
Books are written in many languages, and BookWyrm should be too. If you know more than one language, you might be able to help us to translate BookWyrm. Find out more about translation.
Are you a BookWyrm instance administrator? You can help to test new features when we release them in a draft version of BookWyrm, and report back on your experiences. This is crucial to helping us to release stable versions with fewer bugs.
BookWyrm ist ein werbefreies, leidenschaftliches Projekt, das keine Absicht hat, nach Risikokapital oder Unternehmensfinanzierungen zu suchen. Wenn du helfen willst, das Projekt am Laufen zu halten, kannst du ein nachhaltiger Mitwirkender über Patreon oder OpenCollectivewerden oder ein einmaliges Geschenk über PayPal machen.