Convert ro Respect\Doc

Open
#22 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
25/100
Issue type
Refactor
Clarity
Needs clarification
Activity status
Stale
Tech stack
php

Research direction

Start by reviewing the project classes and their public methods, then inspect the existing unit tests to identify where Respect\Doc-style examples and PHPDoc are needed. Done means the relevant methods have appropriate visibility, the tests serve as examples, and the selected classes and methods have the requested documentation.

Written by the indexing model from the issue text.

Description

feature

Start using Respect/Doc into project, this implies into:

  • Making many public method protected
  • Creating better unit tests to be used as examples
  • Adding little PHPDoc to some classes and methods
Dominant language
PHP
Stars
99
Forks
7
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

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 Respect/Config

All issues in Respect/Config

Similar issues

More PHP issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.