kantord/SeaGOAT

Support Mac OS. Help wanted 馃檹馃崕

Open

#178 opened on Sep 7, 2023

View on GitHubContributor guide
聽(9 comments)聽(0 reactions)聽(0 assignees)Python聽(91 forks)github user discovery
help wantedup for grabs

Repository metrics

Stars
聽(1,302 stars)
PR merge metrics
聽(No merged PRs in 30d)

Description

At all steps, SeaGOAT is developed with guaranteeing Mac OS support. That being said, as I don't have a Mac OS device and I don't have expertise regarding Mac OS development workflows, I have not been able to verify that it works properly.

Help wanted!

Here is a rough checklist of the current status of Mac OS support:

  • Enable CI checks for Mac OS
  • Make sure that all CI tests pass for Mac
  • Manually test SeaGOAT on Mac
  • Document installation steps on Mac
  • Make sure that any required Mac-specific features are implemented
  • Make sure that it's easy to install on Mac using common tools (homebrew?)

Currently the main problem is that I have not been able to try and run SeaGOAT manually on OSX.

Also I have discovered that some of the tests are failing, so I created a CI file specifically for OSX that only checks some of the tests are are passing without issue:

https://github.com/kantord/SeaGOAT/blob/1edae8e4b9272906300046cf99bb5de8fd4256aa/.github/workflows/test-mac-os.yml#L56-L58

For comparison the Linux tests look like this:

https://github.com/kantord/SeaGOAT/blob/1edae8e4b9272906300046cf99bb5de8fd4256aa/.github/workflows/test.yml#L56-L58

Contributor guide

Research direction
Run the tests on a Mac OS environment, identify which tests fail, and debug the failures. Also review the current CI configuration for Mac and ensure all tests pass. Document the installation steps for Mac, including using Homebrew if applicable. Check for any Mac specific requirements (e.g., file system differences) and implement them.
Tech stack
python
Domain
cli
Issue type
Chore
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
PythonGitGitHub Actions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55