Moved programming docs
This commit is contained in:
parent
21eed13750
commit
72bac77ca8
16 changed files with 24 additions and 3 deletions
|
|
@ -1,5 +1,21 @@
|
||||||
# Code review practices
|
# 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
|
## Write actionable comments
|
||||||
|
|
||||||
[Conventional comments](https://conventionalcomments.org/)
|
[Conventional comments](https://conventionalcomments.org/)
|
||||||
|
|
@ -1,8 +1,13 @@
|
||||||
# What I've learned from working on a team.
|
# What I've learned from working on a team.
|
||||||
|
|
||||||
A cordial working environment is more important than getting everything your
|
A cordial working environment is more important than getting everything your way
|
||||||
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.
|
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
|
Some devs are mediocre programmers. Some devs are mediocre communicators. Some
|
||||||
are both.
|
are both.
|
||||||
Loading…
Add table
Add a link
Reference in a new issue