Skip to content

Instantly share code, notes, and snippets.

@tjunghans
Last active February 22, 2021 10:28
Show Gist options
  • Select an option

  • Save tjunghans/42998aca012aba998611036e8f9bf247 to your computer and use it in GitHub Desktop.

Select an option

Save tjunghans/42998aca012aba998611036e8f9bf247 to your computer and use it in GitHub Desktop.
Frontend Developer Guidelines

Frontend Developer Guidelines

Pull Requests and Code Reviews

Creating Pull Requests

  • One commit per pull request. Squash commits before merging.
  • Strive for one feature or bugfix per pull request.
  • Link the pull request to a jira using the git branch name.
  • The branch name of the pull request has the following convention: feature|bugfix/MTB-####-short-description-of-change
  • Use https://www.conventionalcommits.org/en/v1.0.0-beta.4/ for commit messages.
  • Add a short description and if necessary include screenshots and videos (if not already available in the jira) to describe the changes. The easier it is to understand the pull request, the faster it will be to review.
  • Update the version number in the package.json to create a new git version and npm publish. (major for breaking change, minor for feature and patch for bugfix or refactor)

Merging a Pull Request

  • Merge into the master branch
  • Make sure all merge checks are in place. The build must be successful and there should be at least one frontend developer approval.
  • Delete the branch that was merged.
  • Move the jira from “Review” to “Develop” once the change can be viewed in the developer environment.

Reviewing a Pull Request

  • Be nice and as objective as possible.
  • Try to pair suggestions and criticism with a solution or hint

State Management

https://blog.isquaredsoftware.com/2021/01/context-redux-differences/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment