Any contributions to Cleodora are more than welcome. This includes software development, writing documentation, commenting on issues or discussions, making proposals for new features, reporting problems, improving the UI layout, helping users or developers and much more.
Anyone who makes any such contribution, however small, will be listed as a contributor.
Contributing to Cleodora can also be a good chance to learn good software development practices to advance in your career. For example extensive testing, writing documentation, code architecture, rigorous (but kind) code reviews and in general a high emphasis on simplicity and quality at the expense of more features.
If you plan major changes please always discuss them first by creating a new issue or adding a comment on existing issues. If you don't, you risk investing a lot of work only to have your changes rejected or requiring a lot of additional work before they can be merged.
- If you want to contribute you are expected to adhere to the Code of Conduct so you should read it first.
- Try the live demo to get a first impression https://demo.cleodora.org
- Install cleodora and try it on your computer, as described here.
- Install the dependencies on your computer or online in Gitpod or GitHub Codespaces as described here.
- Run the tests, as described here.
- Run
cleosrv,cleocand thefrontendas described here - Grab one of the good first issue issues and start working. In particular the exercises may be very useful.
- If you had any difficulty getting started, please improve this documentation. See #145.
See the Development Documentation for more information.