matomo-org / matomo-org/developer-documentation
Create a style guide page for plugin developers
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 58
- Forks
- 88
- Avg merge
- 6d 3h
- Merged PRs (30d)
- 13
Description
* Should include naming for common db fields like `created_date`, `updated_date` to have this consistent (also reflects later in API calls etc)
* Common naming for DB tables (eg singular vs plural)
* Explain `Dao` vs `Models` etc.
As it is a lot of work to create such a document I suggest we simply start with a few styles and tweak it over time. Some parts are already defined here: https://developer.piwik.org/guides/contributing-to-piwik-core we would need to extract some of this stuff and put it into a separate document as contributing to Piwik core page is way too long.
Then we can also link to that page from the "Develop => Getting started" category.
Any thoughts @mattab @sgiehl ?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the existing “Contributing to Piwik core” guide linked in the issue and identify the style guidance to extract. Create a separate plugin-developer style guide covering the listed naming and architecture topics, then link it from the “Develop => Getting started” category.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 32/100