Skip to content

Latest commit

 

History

History
33 lines (21 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

33 lines (21 loc) · 1.55 KB

Contributing to GenWorlds Community

Hi there! Thank you for even being interested in contributing to GenWorlds Community. As an open source project in a rapidly developing field, we are extremely open to contributions, whether they be in the form of new features, improved infra, better documentation, or bug fixes.

🚧 This page is under construction

🚩 GitHub Issues

Our issues page is kept up to date with bugs, improvements, and feature requests.

There is a taxonomy of labels to help with sorting and discovery of issues of interest. Please use these to help organize issues.

If you start working on an issue, please assign it to yourself.

If you are adding an issue, please try to keep it focused on a single, modular bug/improvement/feature. If two issues are related, or blocking, please link them rather than combining them.

We will try to keep these issues as up to date as possible, though with the rapid rate of develop in this field some may get out of date. If you notice this happening, please let us know.

🚀 Running it with Docker Compose (dev mode)

This is the recommended way to run the framework in development mode. It will run all the services in the framework and will allow you to modify the code and see the changes in real time. Also to change the framework, if you have it in the same parent folder as the community edition, it will also be updated in real time.

It takes a while to build the first time, and some disk space, but it's worth it.

docker compose up