Skip to content

Contributing Guide

Lawrence Fernandes edited this page Aug 8, 2022 · 6 revisions

How to Contribute

We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.

Code Reviews

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.

Before opening a pull request to suggest a feature change, please open a Github Issue to discuss the use-case and feature proposal with the project maintainers. After this aligment, you can fork the project, improve it and open a pull request!

Development

Debussy is currently beign developed on native Ubuntu/Debian linux distributions or through Windows Subsystem for Linux (WSL). It may not work properly on other OS such as MacOS, Windows/cygwin, or CentOS/Fedora/FreeBSD, etc.

For development or trying out Debussy, we recommend using Astro, mounting the path to the project on the docker-compose.override.yml file, according Astro's docs.

Dependencies

Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq

Clone this wiki locally