oxidecomputer / oxidecomputer/oxide.go

Release Process Cleanup: Go SDK

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

Nobody has claimed this yet.

Go SDK Task
Dominant language
Go
Stars
26
Forks
6
Avg merge
5h 33m
Merged PRs (30d)
9

Description

Let's clean up the release process across our repositories so that the release process is documented in a consistent location.

  • Create a top-level CONTRIBUTING.adoc file. If there's an existing CONTRIBUTING.md file, rename it to CONTRIBUTING.adoc.
  • Document the release process in a new or existing section within CONTRIBUTING.adoc.
  • Delete the .github/ISSUE_TEMPLATE/release_checklist.md file and any other issue templates that have to do with releasing except for release.yaml. Be sure to synthesize the instructions from these deleted files into CONTRIBUTING.adoc.

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

Check for an existing top-level CONTRIBUTING.md and inspect .github/ISSUE_TEMPLATE/release_checklist.md plus other release-related templates, leaving release.yaml in place. Consolidate their release instructions in top-level CONTRIBUTING.adoc, rename CONTRIBUTING.md if present, and verify the obsolete release templates are removed.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
documentation, release
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.