Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update contributing guide #2586

Merged
merged 3 commits into from
Jun 14, 2024

Conversation

mdelapenya
Copy link
Collaborator

@mdelapenya mdelapenya commented Jun 14, 2024

Render URL: https://deploy-preview-2586--testcontainers-go.netlify.app/contributing/

What does this PR do?

This PR updates the contributing guide including how to update the codebase when the core go.mod is updated.

It also include info about passing golangci-lint in the codebase (core and submodules).

Finally it updates the makefile to use simpler names.

Why is it important?

Everytime the core go.mod is updated, the changes must be propagated to all the downstream modules.

Related issues

@mdelapenya mdelapenya added the documentation Docs, docs, docs. label Jun 14, 2024
@mdelapenya mdelapenya requested a review from a team as a code owner June 14, 2024 18:40
@mdelapenya mdelapenya self-assigned this Jun 14, 2024
Copy link

netlify bot commented Jun 14, 2024

Deploy Preview for testcontainers-go ready!

Name Link
🔨 Latest commit 518d8e1
🔍 Latest deploy log https://app.netlify.com/sites/testcontainers-go/deploys/666c9005b378230008fc4411
😎 Deploy Preview https://deploy-preview-2586--testcontainers-go.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

docs/contributing.md Outdated Show resolved Hide resolved
Copy link
Contributor

@thaJeztah thaJeztah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM (but didn't test locally 😅), thanks!

docs/contributing.md Show resolved Hide resolved
@mdelapenya mdelapenya merged commit dd7d7a9 into testcontainers:main Jun 14, 2024
106 of 107 checks passed
mdelapenya added a commit that referenced this pull request Jun 17, 2024
* chore: update make targets

* docd: update contributing guides with go.mod and lint work

* docs: wording
mdelapenya added a commit to mdelapenya/testcontainers-go that referenced this pull request Jun 24, 2024
* main:
  docs: document disabling ryuk with properties (testcontainers#2603)
  fix: allow compose files and readers to be used together (testcontainers#2598)
  chore(deps): bump urllib3 from 2.2.1 to 2.2.2 (testcontainers#2590)
  docs: example for NATS cluster (testcontainers#2591)
  docs: fix deprecation for material extensions emoji (testcontainers#2592)
  gha: update golangci-lint to v1.59.1 (testcontainers#2588)
  network: WithCheckDuplicate: don't set CheckDuplicate value (testcontainers#2589)
  fix: proper synchronisation for start/stop log production (testcontainers#2576)
  chore(deps): bump github.com/docker/docker from v25.0.5 to v26.1.4 (testcontainers#2584)
  docs: update contributing guide (testcontainers#2586)
  feat: add testcontainers labels to the built images (testcontainers#2579)
  feat(mongodb): Make the replica set name configurable (testcontainers#2538)
  chore: skip reaper tests if ryuk is disabled (testcontainers#2582)
  chore: increase check time to 60 secs instead of 20 (testcontainers#2581)
  fix: prepend substitutors for built images (testcontainers#2577)
  docs: update colima docs (testcontainers#2578)
  fix(cockroachdb): Fixes cockroachdb wait strategy handling (testcontainers#2456)
  Fix race condition when looking up reaper (ryuk) container (testcontainers#2508)
  chore: bring golangci-lint back (testcontainers#2571)
  docs(compose): Fix typo docker compose docs (testcontainers#2565)
@mdelapenya mdelapenya deleted the contributing-guides branch June 27, 2024 14:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Docs, docs, docs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants