diff --git a/docs/programming/general/_index.md b/docs/professional/software-development-practices/_index.md similarity index 100% rename from docs/programming/general/_index.md rename to docs/professional/software-development-practices/_index.md diff --git a/docs/programming/general/code-review.md b/docs/professional/software-development-practices/code-review.md similarity index 67% rename from docs/programming/general/code-review.md rename to docs/professional/software-development-practices/code-review.md index 0800e4f..c224c87 100644 --- a/docs/programming/general/code-review.md +++ b/docs/professional/software-development-practices/code-review.md @@ -1,5 +1,21 @@ # Code review practices +## Who should review? + +Code should be reviewed by senior developers who understand the system being +changed. + +Code can also be reviewed by more junior developers, as they can learn about the +system by comprehending the changeset, and they can spot some mistakes or +problems. However these reviewers should not be able to approve pull requests. + +## What should be reviewed? + +- The change should make sense to the reviewer. +- The code should meet the team's standards for maintainability. +- The changeset should be limited to the problem being solved by the pull + request. + ## Write actionable comments [Conventional comments](https://conventionalcomments.org/) diff --git a/docs/programming/general/coding-for-humans.md b/docs/professional/software-development-practices/coding-for-humans.md similarity index 100% rename from docs/programming/general/coding-for-humans.md rename to docs/professional/software-development-practices/coding-for-humans.md diff --git a/docs/programming/general/coding-practices-for-teams.md b/docs/professional/software-development-practices/coding-practices-for-teams.md similarity index 100% rename from docs/programming/general/coding-practices-for-teams.md rename to docs/professional/software-development-practices/coding-practices-for-teams.md diff --git a/docs/programming/general/motivation.md b/docs/professional/software-development-practices/motivation.md similarity index 100% rename from docs/programming/general/motivation.md rename to docs/professional/software-development-practices/motivation.md diff --git a/docs/programming/general/pull-requests.md b/docs/professional/software-development-practices/pull-requests.md similarity index 100% rename from docs/programming/general/pull-requests.md rename to docs/professional/software-development-practices/pull-requests.md diff --git a/docs/programming/general/working-on-a-team.md b/docs/professional/software-development-practices/working-on-a-team.md similarity index 72% rename from docs/programming/general/working-on-a-team.md rename to docs/professional/software-development-practices/working-on-a-team.md index b9ae5e6..dde4954 100644 --- a/docs/programming/general/working-on-a-team.md +++ b/docs/professional/software-development-practices/working-on-a-team.md @@ -1,8 +1,13 @@ # What I've learned from working on a team. -A cordial working environment is more important than getting everything your -way, or optimal engineering practices. You have to pick your battles and focus -on fixing just the things that you can't work with at all. +A cordial working environment is more important than getting everything your way + +If devs don't like working with each other then the team's productivity will +collapse. It helps to maintain a collegial working atmosphere, where devs feel +valued and petty politics are kept to a minimum. + +You have to pick your battles and focus on fixing just the things that you can't +work with at all. Some devs are mediocre programmers. Some devs are mediocre communicators. Some are both. diff --git a/docs/programming/general/writing-good-code.md b/docs/professional/software-development-practices/writing-good-code.md similarity index 100% rename from docs/programming/general/writing-good-code.md rename to docs/professional/software-development-practices/writing-good-code.md diff --git a/docs/programming/web/_index.md b/docs/professional/web-technologies/_index.md similarity index 100% rename from docs/programming/web/_index.md rename to docs/professional/web-technologies/_index.md diff --git a/docs/programming/web/drupal/community.md b/docs/professional/web-technologies/drupal/community.md similarity index 100% rename from docs/programming/web/drupal/community.md rename to docs/professional/web-technologies/drupal/community.md diff --git a/docs/programming/web/drupal/contrib.md b/docs/professional/web-technologies/drupal/contrib.md similarity index 100% rename from docs/programming/web/drupal/contrib.md rename to docs/professional/web-technologies/drupal/contrib.md diff --git a/docs/programming/web/drupal/ddev.md b/docs/professional/web-technologies/drupal/ddev.md similarity index 100% rename from docs/programming/web/drupal/ddev.md rename to docs/professional/web-technologies/drupal/ddev.md diff --git a/docs/programming/web/tech-stack/_index.md b/docs/professional/web-technologies/tech-stack/_index.md similarity index 100% rename from docs/programming/web/tech-stack/_index.md rename to docs/professional/web-technologies/tech-stack/_index.md diff --git a/docs/programming/web/tech-stack/languages.md b/docs/professional/web-technologies/tech-stack/languages.md similarity index 100% rename from docs/programming/web/tech-stack/languages.md rename to docs/professional/web-technologies/tech-stack/languages.md diff --git a/docs/programming/web/tech-stack/overview.md b/docs/professional/web-technologies/tech-stack/overview.md similarity index 100% rename from docs/programming/web/tech-stack/overview.md rename to docs/professional/web-technologies/tech-stack/overview.md diff --git a/docs/programming/web/tech-stack/plan.md b/docs/professional/web-technologies/tech-stack/plan.md similarity index 100% rename from docs/programming/web/tech-stack/plan.md rename to docs/professional/web-technologies/tech-stack/plan.md