Skip to content

Contributing rules

We are happy and welcome if you want to contribute to Vuelto. But please consider a few details before continuing:

  1. Fork: Please before working, make sure you forked the repo and are working inside the fork
  2. Branch: Please before working in your own fork, make sure you are in the latest branch.
  3. Explain: Please explain why this should be considered and merged. That can increase he chance for us to merge and will safe the maintainers time.
  4. Test: Please test your code before even opening a new pull request. Make sure the CI doesn't fail.
  5. Documentation: Please, if your adding something new, like a feature, please document everything.
  6. Format: Please, run go fmt ./... for formatting of the code. Without this we won't merge your code
  7. CI: We cannot merge if the CI fails. Incase that it fails, please fix your code or fix the CI (only incase of breaking changes or improvements).

Breaking the rules

Not following these rules will result in us in pointing out the mistake and not merging your pull request, until you have it fixed. We do NOT allow license changing pull requests. Joke pull requests or disrespecting behavior will be considered as breaking the Code Of Conduct. So please make sure you followed the rules before contributing. Thanks!

Information

Some technologies we are using - Go-GLFW: Main windowing system, possible fallback if custom bindings fail. - OpenGl/WebGL: Rendering api, both combined create a small gl api used in the engine itself. - “syscall/js”: This is the way Vuelto is interacting with WebGL and Web interface. - CGo: Interface to use C with Go, used in the engine itself and Go-GLFW.

Extras: - OpenGL bindings are generated by glow

Getting ready for contribution

  • Make sure you have all the dependencies installed. For Nix/Nixos users a shell.nix file exists, so running nix-shell inside the cloned repo is enough.
  • Fork the repository.
  • Clone your forked github repository:
git clone https://github.com/<your_username>/vuelto.git

  • Change the branch to the dev branch to follow rule #1: 

    git checkout dev

  • Run go mod tidy to install all the packages.

Pull Request

When you're ready with your changes, make sure you format your code before opening a pull request:

go fmt ./...

And of course, make sure you followed the contributing-rules.

After all of this, you can create a pull request and one of our members will take a look at it (and possibly merge it!).