Skip to content

Added contributor.md and updated code block styles to better fix github markdown patterns #1997

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

MSeal
Copy link

@MSeal MSeal commented Jun 13, 2025

Adds contributor markdown and cleans up some of documentation. This is an effort as a precursor to engaging the community for completely.

This adds a Contributor.md file, changes the setup instructions to include virtual environment, removes the python2 vs 3 implication for older OS defaults, changes code references to code blocks, and adds some cross md file references where relevant.

Checklist

  • Contains customer facing changes? Including API/behavior changes
  • Did you add sufficient unit test and/or integration test coverage for this PR?
    • If not, please explain why it is not required
    • Documentation change only, no behavior or code differences

References

JIRA:

Test & Review

Open questions / Follow-ups

This had been discussed internally ahead of time, nothing surprising for confluent reviewers should pop up.

Initial changes were drafted with cursor then hand touched and reviewed to ensure intent and quality. Recommended that instructions are clear and no typos or mistakes are present in a read through.

@MSeal MSeal self-assigned this Jun 13, 2025
@Copilot Copilot AI review requested due to automatic review settings June 13, 2025 23:48
@MSeal MSeal requested review from a team as code owners June 13, 2025 23:48
@MSeal MSeal added the docs Improve docs label Jun 13, 2025
@confluent-cla-assistant
Copy link

🎉 All Contributor License Agreements have been signed. Ready to merge.
Please push an empty commit if you would like to re-run the checks to verify CLA status for all contributors.

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds a new CONTRIBUTOR.md file and standardizes documentation by converting inline command snippets to fenced bash code blocks and unifying Python invocation.

  • Adds detailed contributor guidelines in CONTRIBUTOR.md
  • Replaces inline shell commands with fenced bash blocks across docs
  • Updates instructions to use python instead of python3

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.

Show a summary per file
File Description
tests/README.md Converted commands to fenced bash blocks and updated Python call
examples/docker/README.md Wrapped Docker build command in fenced bash block
examples/README.md Standardized venv and install commands with fenced bash blocks
README.md Fenced installation commands in bash blocks
INSTALL.md Unified Python invocation and added fenced bash blocks
DEVELOPER.md Added setup section and fenced build/docs/unasync commands
CONTRIBUTOR.md Introduced new contributor guidelines documentation
Comments suppressed due to low confidence (4)

tests/README.md:17

  • Consider specifying "Python 3.x" explicitly instead of just "python", since on some systems python may point to Python 2 or be unavailable.
A python env suitable for running tests:

INSTALL.md:11

  • On environments where python defaults to Python 2 or is not installed, consider using python3 or adding a note about requiring Python 3.
python -m pip install confluent-kafka

DEVELOPER.md:80

  • The code fence here wraps both the python tools/unasync.py command and the explanatory comment. It may improve clarity to separate the two into distinct fenced blocks or move the comment outside the block.
```bash

CONTRIBUTOR.md:27

  • Relative link to ../../issues may not resolve correctly in GitHub Markdown; consider using an absolute path like /issues or linking directly to the repository's issues page.
[issues](../../issues)

@sonarqube-confluent
Copy link

Passed

Analysis Details

0 Issues

  • Bug 0 Bugs
  • Vulnerability 0 Vulnerabilities
  • Code Smell 0 Code Smells

Coverage and Duplications

  • Coverage No coverage information (66.00% Estimated after merge)
  • Duplications No duplication information (5.20% Estimated after merge)

Project ID: confluent-kafka-python

View in SonarQube

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improve docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant