OpenFish Documentation

Appearance

Openfish Contributing Guide ​

Authors: Scott Barnard

Hi there! 👋 We’re thrilled that you’re interested in contributing to OpenFish, our open-source project dedicated to classifying marine species.

Before diving in, please take a moment to familiarize yourself with our guidelines. These will help streamline the contribution process and ensure a smooth collaboration. Here’s what you need to know:

Raising issues. ​

If you find a bug or want to request a feature, please raise an issue https://github.com/ausocean/openfish/issues.

For bugs, try to include any information that you think is helpful in describing the problem and ideally the steps you need to reproduce the issue. The better the information you include, the quicker it is likely to be fixed.

Use the labels document, bug and enhancement to categorize your issue.

Choosing an issue to work on. ​

Issues with the good first issue label are a good choice for your first contribution.

Repo Setup ​

If you want to contribute code to the project, use these steps instead to get started:

Prerequisites ​

You will need installed:

  • gcloud CLI
  • node v19.2.0 or later
  • pnpm v8.5.1 or later
  • go 1.20 or later
  • Linux (Windows is currently untested but may work)

Steps: ​

  1. Setup google cloud credentials so your application can access the datastore:

    bash
    gcloud auth login
gcloud config set project openfish-dev
gcloud auth application-default login

    if the environment variable $GOOGLE_APPLICATION_CREDENTIALS is not set:

    bash
    GOOGLE_APPLICATION_CREDENTIALS=~/.config/gcloud/application_default_credentials.json

  2. Install npm dependencies:

    bash
    pnpm install

  3. Start the API:

    bash
    go run ./api

  4. Start the webapp using vite's development server:

    bash
    pnpm --filter ./openfish-webapp dev

  5. Open the browser and visit http://localhost:5173/watch.html.

  6. (Optional) Serve the documentation website using:

    bash
    pnpm --filter ./docs dev

Common tasks ​

Formatting code ​

bash
go fmt ./... && swag fmt
bash
pnpm --filter webapp fmt

Running unit tests ​

bash
go test -v ./... -short
bash
pnpm --filter webapp test

Linting (Front-end only) ​

bash
pnpm --filter webapp check
bash
pnpm --filter webapp check --fix

Submitting a pull request (PR) ​

  • If the PR is related to an issue, link to it in the description.
  • Check that your code passes unit tests.
  • Check that your code is formatted properly.
  • Check that your code does not have any linting issues.

Summary ​

Thank you for joining the OpenFish community! We can’t wait to see your contributions in action 🌊🐠🦑!