shift-org / shift-org/shift-docs

Tag releases and version the API

Open
#561 2 comments 0 reactions 1 assignee View on GitHub

@carrythebanner is already working on this.

Since Jan 22, 2024.

API documentation
Dominant language
JavaScript
Stars
30
Forks
25
Avg merge
9m
Merged PRs (30d)
1

Description

Tagging releases would help us maintain a more human-friendly version log. They would help:

  • track notable releases, so we can easily determine when a feature or change was made, or know the code which was current at a given time (e.g. "What was the state of the calendar for PP 2023?")
  • version the API, to create a better contract for external API users

Contributor guide

No contributing guide indexed for this repository

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.