docs(readme): make first-contribution opportunities easy to find

Open Beginner friendly
  • Is something wrong?
#647 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
88/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
markdown, python
Domain
documentation

Research direction

Edit README.md near the bottom, above the Disclaimer or License section where applicable. Read the existing README structure and CONTRIBUTING.md first, then verify the requested links point to this repository’s guide and label filters. Done when the brief section explains the two task labels, asks contributors to comment before opening a PR, and invites issues or documentation suggestions without implying tasks are currently available.

Written by the indexing model from the issue text.

Description

documentation good first issue priority: low size: XS

Context

The English README has no clear, short ## Contributing section linking newcomers to first-contribution issues. The detailed installation and PR workflow already belongs in CONTRIBUTING.md; repeating it in README would create drift.

Scope

  • Add a concise ## Contributing section to README.md, near the bottom and above Disclaimer/License where applicable.
  • Link to CONTRIBUTING.md, good first issue, and help wanted.
  • Explain in plain English: starter tasks are bounded, help-wanted tasks may need codebase context, and contributors should comment to request assignment before opening a PR.
  • Invite issues and small documentation suggestions even if the label filters are empty.
  • This README already documents significant logging behavior; avoid making the contributor entry another long troubleshooting section. Existing contributor quickstart is #453.

Acceptance Checklist

  • The English README leads readers directly to the existing contribution guide and this repository's label filters.
  • The change is brief, human-readable, and does not promise that an issue is available right now.
  • Links are verified and the PR reports any Markdown/docs check actually run.
  • No code, workflow, release, or mandatory translation-sync policy changes.

Out of scope

  • Rewriting CONTRIBUTING.md or AGENTS.md, changing claim/assignment policy, or altering published package behavior. Agent reservation is tracked in cookbook #472 as a maintainer-first pilot.

Contributor notes

Comment to request assignment before you begin. No Azure credentials are needed. Keep the PR scoped to this repository and reference this issue with Closes #<number>. Suggested title: docs(readme): make first-contribution opportunities easy to find.

Reference: OpenAPI #854 (already implemented; verify this repository's structure instead of copying blindly).

Dominant language
Python
Stars
15
Forks
0
Avg merge
7h 53m
Merged PRs (30d)
90

Getting set up

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.

More from yeongseon/azure-functions-logging-python

All issues in yeongseon/azure-functions-logging-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.