Skip to content

docs: add contributing guidelines (CONTRIBUTING.md) (#14)#44

Merged
Mike031289 merged 1 commit into
developfrom
docs/contributing-guide
Jul 17, 2026
Merged

docs: add contributing guidelines (CONTRIBUTING.md) (#14)#44
Mike031289 merged 1 commit into
developfrom
docs/contributing-guide

Conversation

@Mike031289

Copy link
Copy Markdown
Owner

This PR introduces the CONTRIBUTING.md guide at the root of the project to streamline onboarding for new developers and standardize code shipping processes.

Content Added

  • Step-by-Step Local Setup: Clear installation instructions including PHP 7.4 prerequisites, Composer dependencies installation, and database parameter setup.
  • Git Workflow Rules: Outlines branching prefix rules (feat/, fix/, docs/, etc.) to keep the history consistent.
  • Commit Quality Standards: Standardizes messaging rules using Conventional Commits.
  • Testing Protocol: Explains how to launch the PHPUnit suite to guarantee non-regression before any production release.

Acceptance Criteria Checklist

  • Create CONTRIBUTING.md at the project root.
  • Document detailed step-by-step installation instructions.
  • Explain Git branching and Conventional Commits naming patterns.
  • Provide exact terminal commands to run automated tests.

Close #14

- Documented local installation guide (PHP 7.4 & MySQL config)
- Explained branch naming conventions and Conventional Commits rules
- Provided commands to run the PHPUnit test suite
@Mike031289 Mike031289 self-assigned this Jul 17, 2026
@Mike031289 Mike031289 added the documentation Improvements or additions to documentation label Jul 17, 2026
@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@Mike031289
Mike031289 merged commit 7e6e9f7 into develop Jul 17, 2026
2 checks passed
@github-project-automation github-project-automation Bot moved this from Backlog to Done in @Mike031289's ToDo-Co Jul 17, 2026
@Mike031289
Mike031289 deleted the docs/contributing-guide branch July 17, 2026 09:20
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: Done

Development

Successfully merging this pull request may close these issues.

1 participant