Skip to content

How to contribute

Olivier Verwoerd edited this page Dec 22, 2023 · 1 revision

Retrieving the Git repository from GitHub:

  1. Log in to your GitHub account and navigate this repository.
  2. Click the "Clone or download" button and copy the repository URL.

Setting up your development environment:

  1. If you don't have Node.js (NPM) yet, download and install it. from the node js website Then choose the LTS version. 18 LTS is fine
  2. Install VS Code if you don't already have it.
  3. Open VS Code and press Ctrl+Shift+P (or Cmd+Shift+P on macOS) to open the Command Palette.
  4. Type "Git: Clone" and select this option. Paste the copied repository URL and press Enter.
  5. Choose a location on your computer where you want to save the repository.

Customizing the Vue site:

  1. Open the cloned repository in the desired folder of the Vue site in VS Code.
  2. Make the desired adjustments to the files. See the VUE and Pinia chapters about how the website works

Submitting a pull request:

  1. After you're happy with your changes and tested them, open the Source Control panel in VS Code by clicking the Git icon on the left side of the sidebar.
  2. Type a short and clear description of your changes in the input field at the top and click the check marks to confirm the changes.
  3. Click on the three dots at the top of the Source Control panel and select "Push". This will push your changes to the GitHub repository.
  4. Go to the repository on GitHub and navigate to the “Pull Requests” tab. Click on the "New pull request" button to create a new request.
  5. To close the associated issue automatically when closing the pull request, write somewhere in the description: closes #<issue no.>. For example: closes #24.
  6. Check the changes and description again and click the "Create pull request" button to submit the request.

Congratulations! You've contributed to science.

Clone this wiki locally