Improve README structure and add contributor guidance#163
Open
mahmoodhamdi wants to merge 1 commit into
Open
Conversation
Contributor
|
@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
0a4f951 to
dacb076
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
including the top-level
SControllerbase classWindows/IIS instructions moved into a subsection of the manual path
db/reference in the commit message, squash before merge, screenshots for UI
changes, propose-large-changes-first)
php-cs-fixerfrom this repo and toward the appropriate workflow
BSD-3-Clausefield fromcomposer.jsonNo content was removed without being preserved or expanded elsewhere.
Fixes #157
Test plan