nusmodifications / nusmodifications/nusmods

Put up deprecation notice for V1 Api

Open
#1,504 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs good first issue
Dominant language
JavaScript
Stars
689
Forks
364
Avg merge
7h 5m
Merged PRs (30d)
14

Description

As the school is going to stop v1 data sources, which prevents us from providing the api any further, we should give appropriate notice for anyone coming to our site.

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 does not name a file, test, or entry point. First locate where the site communicates API availability, then confirm the wording and placement of a V1 API deprecation notice with the maintainers. Done means visitors receive an appropriate notice before V1 data sources stop being available.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.