Skip to content

Commit

Permalink
Add code comments article
Browse files Browse the repository at this point in the history
  • Loading branch information
theodorosploumis committed Oct 3, 2022
1 parent e7c0ccd commit adf2bb1
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,7 @@
- When creating a Drupal distribution use an 1 word machine name without underscores (eg prefer "myproject" instead of "my_project").
- All custom specific modules MUST be prefixed with `projectmachinename_`.
- Use [drupal console](https://drupalconsole.com) or [drush](https://github.com/drush-ops/drush) to generate code (modules, plugins etc).
- For any code comments follow the rules from [Best practices for writing code comments, stackoverflow.blog by Ellen Spertus, 2021](https://stackoverflow.blog/2021/12/23/best-practices-for-writing-code-comments/)

#### 4.3 VCS - git
- Use a git online UI (GitHub, Gitlab, Bitbucket etc). On the same system add your issues, documentation and [CI](https://cgit.drupalcode.org/drupal/tree/core/drupalci.yml) automation workflows.
Expand Down

0 comments on commit adf2bb1

Please sign in to comment.