Developer Documentation for Adding Styles
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 38/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- emacs, php, symfony
- Domain
- documentation
Research direction
No file or test is named in the issue. Start by reviewing the existing project documentation or wiki and the Symfony2 style addition to identify the steps developers followed. Done means a concise checklist documenting the process for introducing a new coding style.
Written by the indexing model from the issue text.
Description
It will be useful to provide a document (or use the project wiki) to outline all of the steps that developers should go through when introducing a new coding style, e.g .the recently added Symfony2 style. From a code perspective the style was completely thorough. All it really lacked was some small amount of documentation. Providing a checklist of these items for developers will be helpful for the future.
- Dominant language
- Emacs Lisp
- Stars
- 602
- Forks
- 117
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
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.
More from emacs-php/php-mode
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
-
Difficulty 4/5 3-5 days Newbie friendliness 20/100
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
All issues in emacs-php/php-mode
Similar issues
-
[Sync EN] Fix session read handler docs: false reports a failure, not a missing session (#5902)Opensync-en
Difficulty 2/5 1-2 days Newbie friendliness 84/100
Maintainers usually reply within 2 days
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
unixorn/awesome-zsh-plugins#2285 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
astrodbtoolkit/astrodb-bot#105 ·