Skip to content

Latest commit

 

History

History
16 lines (11 loc) · 2.05 KB

CONTRIBUTING.md

File metadata and controls

16 lines (11 loc) · 2.05 KB
Raw

Contributing

If you find a bug or have a feature request, the first step is to create an issue in Gitlab for it. After that, contributions are most definitely welcome.

To make contributing easier, this repo has a .devcontainer configuration file (learn more) that will configure VSCode for developing. If you're not already familiar with developing using VSCode and a docker container, I suggest you check out the VSCode docs. If you don't want to do that though, here's the short verson:

  1. Open VSCode on your computer.
  2. Install the Remote - Containers official extension. Follow the installation instructions for the extension.
  3. Clone this repo and open it on your computer. You should then be prompted to "Reopen in container" (do so).
  4. After the container setup is complete, open the VSCode integrated terminal and try running the tests yarn test. They should all pass.

FAQ

  1. By default, you might not be able to push any git commits using VSCode running inside a dev container. To fix this issue, read this VSCode Article.
    • Additionally, try using the VSCode terminal to run git fetch. You might be prompted with a warning saying ~ "The authenticity of host can't be established" and asking you if you want to continue (yes/no). After responding, you might be able to use VSCode's built in git UI normally again.
  2. If you run out of memory while developing inside a docker container, see the VSCode Docs for fixes. The short version is that you need to open up docker preferences/settings and change the amount of memory allocated to your containers.