CONTRIBUTING.md

How to contribute

First of all, thanks for considering contributing to Voila!

If you haven't already, come to our Discord! There is where we discuss the future of the project.

Here are some important resources:

• Code of conduct
• Roadmap

Submitting changes

For submitting a change to Voila source code and contributing to it, please send a GitHub Pull Request to Voila with a clear list of what you've done (read more about pull requests).

Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:

$ git commit -m "A brief summary of the commit
> 
> A paragraph describing what changed and its impact."

Coding conventions

Start reading our code and you'll get the hang of it. We optimize for readability:

• We indent using 4 spaces
• Comment the code for explaining its purpose and what does, but without writing, obvious, unnecessary and redundant comments.
• We ALWAYS put spaces after list items and method parameters ([1, 2, 3], not [1,2,3]), around operators (x += 1, not x+=1), around arrows (...) -> ..., not ...)->...), before curly brackets () {, not ){), etc. This is just a convention, as when upload code to the repo it gets formatted automatically. This is open source software. Consider the people who will read your code, and make it look nice for them. It's sort of like driving a car: Perhaps you love doing donuts when you're alone, but with passengers the goal is to make the ride as smooth as possible.

---

Thanks, Guillem L. (alias alonely0), creator of Voila.