OAI / OAI/spec.openapis.org

add workflow with website test

Open
#27 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Housekeeping
Dominant language
HTML
Stars
12
Forks
18
Avg merge
7h 31m
Merged PRs (30d)
4

Description

One of the recent dependabot updates introduced 85 warnings when building the website, before we were at zero warnings.

If a future dependabot update introduces errors, it will break the site without warning.

  • add test that verify successful build
  • add tests for important site features, for example that the navigation sidebar contains key menu items, or that the /oas page lists all major spec versions (we broke both in the past without noticing it)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files or existing tests, so first locate the website build and workflow configuration. Add coverage for a successful build and important site features such as sidebar menu items and major spec versions on /oas; done means future warnings or errors and regressions are detected automatically.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
ci-cd, testing
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.