Skip to content

docs: Update README.md#29

Merged
DevStrikerTech merged 2 commits intoDevStrikerTech:devfrom
saimayasmeen4:docs/readme-small-update
Apr 11, 2026
Merged

docs: Update README.md#29
DevStrikerTech merged 2 commits intoDevStrikerTech:devfrom
saimayasmeen4:docs/readme-small-update

Conversation

@saimayasmeen4
Copy link
Copy Markdown
Contributor

docs: small README improvements

Summary

This PR includes small improvements to the README file, such as grammar fixes, wording clarity, and minor formatting updates.

Type

  • feat — new capability
  • fix — bug fix
  • refactor / perf — behavior-preserving change
  • test — tests only
  • [ x ] docs / chore — docs or tooling

Links

  • Tracking:
  • Related PRs / context:

Branch policy

  • Base branch is dev (never prod except release mechanics agreed separately).
  • Source branch is feat/<name> or fix/<name>.

Checklist

  • Follows CONTRIBUTING.md (branch flow, quality gates, commit message format).
  • Links to related issues or Project items where applicable.
  • Tests added or updated for behavior changes.
  • Docs updated when user-visible behavior or public API changes.
  • ruff check src tests and ruff format --check src tests pass locally.
  • mypy src/oris tests passes locally.
  • pytest passes with coverage ≥ 84%.
  • No secrets, tokens, or credentials in the diff.

How to verify

Risk / rollout

docs: small README improvements
@DevStrikerTech DevStrikerTech changed the title Update README.md docs: Update README.md Apr 11, 2026
@DevStrikerTech DevStrikerTech self-requested a review April 11, 2026 10:35
@DevStrikerTech DevStrikerTech added the documentation Improvements or additions to documentation label Apr 11, 2026
@DevStrikerTech DevStrikerTech moved this to Reviews in Oris Apr 11, 2026
Copy link
Copy Markdown
Owner

@DevStrikerTech DevStrikerTech left a comment

Choose a reason for hiding this comment

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

LGTM

@DevStrikerTech DevStrikerTech merged commit 5e19a11 into DevStrikerTech:dev Apr 11, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: Reviews

Development

Successfully merging this pull request may close these issues.

2 participants