Skip to content

Improve README structure and add contributor guidance#163

Open
mahmoodhamdi wants to merge 1 commit into
sunnah-com:masterfrom
mahmoodhamdi:docs-improve-readme-structure
Open

Improve README structure and add contributor guidance#163
mahmoodhamdi wants to merge 1 commit into
sunnah-com:masterfrom
mahmoodhamdi:docs-improve-readme-structure

Conversation

@mahmoodhamdi
Copy link
Copy Markdown

Summary

Restructure the README around a table of contents and dedicated sections so new
contributors can scan it quickly and find the information they need.

Changes:

  • Add a Table of Contents linking to each section
  • Convert the project structure overview into a table for easier scanning,
    including the top-level SController base class
  • Split the setup into "Quick Start with Docker" and "Manual Setup", with the
    Windows/IIS instructions moved into a subsection of the manual path
  • New "Sample Database" section describing the SQL seed files in db/
  • New "Contributing" section with PR guidelines (one concern per PR, issue
    reference in the commit message, squash before merge, screenshots for UI
    changes, propose-large-changes-first)
  • "Code Style" subsection pointing to php-cs-fixer
  • "Content Corrections" subsection redirecting hadith content corrections away
    from this repo and toward the appropriate workflow
  • "License" section quoting the BSD-3-Clause field from composer.json

No content was removed without being preserved or expanded elsewhere.

Fixes #157

Test plan

  • Renders correctly as Markdown on GitHub
  • All TOC anchors resolve to existing headings
  • All external links use HTTPS and point to live pages
  • No technical claims added that aren't verifiable from the repo

@ahadith
Copy link
Copy Markdown
Contributor

ahadith commented May 12, 2026

@fsid could you please review?

Restructure the README around a table of contents and dedicated
sections for project structure, Docker quick start, manual setup,
sample database, contributing, and license. Add explicit pull
request guidelines, a code-style pointer to php-cs-fixer, and a
note redirecting hadith content corrections to the proper workflow.

Fixes sunnah-com#157
@mahmoodhamdi mahmoodhamdi force-pushed the docs-improve-readme-structure branch from 0a4f951 to dacb076 Compare May 12, 2026 09:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve README structure and contributor guidance

2 participants