Skip to content
Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
55 lines (36 sloc) 2.95 KB

Contribution guidelines

Branching

Create your own branches from master and use a descriptive prefix:

# For bug fixes, ideally finishing with the ticket number.
fix/<branch name>-<ticket number>
# For features, as well finishing with the ticket number if there is one.
feature/<branch name>-<ticket number>
# For general non-functional improvements (eg. developer tooling, CI)
chore/<branch name>-<ticket number>

When you're done with your work, create a pull request and find another teammate to review the changes.

Code reviews

We do code reviews to ensure our work is of good quality, and to share knowledge. Reviews come in all shapes and sizes – from thorough point-by-point pull request reviews in GitLab to simple discussion of the proposed changes.

Why we review each other’s work

  • Improve the overall quality of the work.
  • Enforce and propagate our standards of quality, best practices, work methodologies, and coding styles.
  • Share the responsibility and knowledge for any given piece of work.
  • Learn from each other’s approaches and skillsets.

Want to know more? Go have a look at Code Reviews: Just Do It from Jeff Atwood.

Guidelines for code reviews

When presenting code for review, or reviewing code, follow these guidelines:

  • Try to make the review beneficial for both reviewee and reviewer.
  • Give enough information to the reviewer so they know where to start.
  • Think about the bigger picture.
  • Concentrate on the intention rather than the syntax – stylistic issues should be taken care of by your linter.
  • Reviews do not need to focus on the negative - if a piece of code is good, it is worth stating as well.

Code reviews in practice

We use GitLab’s Merge Requests feature or GitHub’s Pull Requests for most of our work, and do code reviews there with Merge request approvals / Pull request reviews. You will use this on a daily basis, take some time to learn how best to leverage those tools.


Useful resources to go further

If you want to invest in figuring out the best guidelines and workflow for your team, here are useful resources to look at so you can have more informed conversations about your particular situation.

You can’t perform that action at this time.