testcontainers / testcontainers/testcontainers-go

[Enhancement]: Release docs from release tag

Open
#511 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Go
Stars
5k
Forks
637
Avg merge
2d 12h
Merged PRs (30d)
26

Description

Proposal

I noticed this page in the docs that mentions the Files: pattern of precopying files

https://golang.testcontainers.org/features/copy_file/

But this isn't in the latest release tag v0.13.0 so it's confusing that the API can't be used. I think the docs are tagged together with the code in this repo, so perhaps they could be released from the tag as well.

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

Start with the documentation page at https://golang.testcontainers.org/features/copy_file/ and compare its Files: API content with the v0.13.0 release tag. Trace how documentation and code are tagged or published in this repository; done means the released docs match the API available from the corresponding code tag.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.