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: better contribution guidelines #2893

Merged
merged 6 commits into from
Nov 22, 2024

Conversation

mdelapenya
Copy link
Member

@mdelapenya mdelapenya commented Nov 20, 2024

What does this PR do?

It merges the existing contribution guides into just one file, describing with more details the contribution process.

It includes recommendations about creating commits and PR titles using conventional commits, which in a short future could serve to generate the changelog instead of using Github labels.

It also fixes the commands used to lint modules, adding a new command to run all lints in the Makefile.

Why is it important?

Better contribution guides are great for newcomers.

@mdelapenya mdelapenya requested a review from a team as a code owner November 20, 2024 12:56
@mdelapenya mdelapenya added the documentation Docs, docs, docs. label Nov 20, 2024
@mdelapenya mdelapenya self-assigned this Nov 20, 2024
@mdelapenya mdelapenya requested a review from stevenh November 20, 2024 12:56
Copy link

netlify bot commented Nov 20, 2024

Deploy Preview for testcontainers-go ready!

Name Link
🔨 Latest commit 351d5ca
🔍 Latest deploy log https://app.netlify.com/sites/testcontainers-go/deploys/673e5c4a7e78e50008f2715c
😎 Deploy Preview https://deploy-preview-2893--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.

Copy link
Collaborator

@stevenh stevenh left a comment

Choose a reason for hiding this comment

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

Just a few suggestions

docs/contributing.md Outdated Show resolved Hide resolved
docs/contributing.md Show resolved Hide resolved
docs/contributing.md Outdated Show resolved Hide resolved
@mdelapenya mdelapenya requested a review from stevenh November 20, 2024 22:01
@mdelapenya mdelapenya merged commit 892cb08 into testcontainers:main Nov 22, 2024
122 checks passed
@mdelapenya mdelapenya deleted the contribution-guidelines branch November 22, 2024 15:13
mdelapenya added a commit to mdelapenya/testcontainers-go that referenced this pull request Nov 25, 2024
* main:
  docs: better contribution guidelines (testcontainers#2893)
  fix(influxdb): Respect custom waitStrategy (testcontainers#2845)
mdelapenya added a commit to mtellis2/testcontainers-go that referenced this pull request Dec 11, 2024
* main: (234 commits)
  chore(ci): add Github labels based on PR title (testcontainers#2914)
  chore(gha): Use official setup-docker-action (testcontainers#2913)
  chore(ci): enforce conventional commits syntax in PR titles (testcontainers#2911)
  feat(nats): WithConfigFile - pass a configuration file to nats server (testcontainers#2905)
  chore: enable implicit default logger only in testing with -v (testcontainers#2877)
  fix: container binds syntax (testcontainers#2899)
  refactor(cockroachdb): to use request driven options (testcontainers#2883)
  chore(deps): bump actions/setup-go from 5.0.0 to 5.1.0 (testcontainers#2904)
  chore(deps): bump ossf/scorecard-action from 2.3.1 to 2.4.0 (testcontainers#2903)
  chore(deps): bump test-summary/action from 2.3 to 2.4 (testcontainers#2902)
  feat(wait): strategy walk (testcontainers#2895)
  feat(wait): tls strategy (testcontainers#2896)
  docs: better contribution guidelines (testcontainers#2893)
  fix(influxdb): Respect custom waitStrategy (testcontainers#2845)
  fix: only upload to sonar on ubuntu-latest (testcontainers#2891)
  fix: build artifact name properly (testcontainers#2890)
  fix: do not run sonar upload when ryuk is disabled (testcontainers#2889)
  fix: update GH actions for uploading/downloading artifacts (testcontainers#2888)
  feat(ci): Enable master moby with rootless (testcontainers#2880)
  fix(redpanda): temporary file use
  ...
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.

2 participants