#Drupal coders software#
The advice included in the section is applicable to all code reviews, not just Drupal reviews. Keep this in mind when reviewing code and review with empathy. When it goes well, we all become better developers and the codebase becomes stronger as a result. It's a learning opportunity for both the author and the reviewer. ▢ Write a useful pull request description including context, questions, or discussion points Reviewing With Empathyįirst and foremost, a code review is about feedback. ▢ Review the diff to make sure only intended changes were included If you're using config splits, double-check that split config has been applied to the default and vice-versa. When making changes to Drupal's configuration, make sure you didn't accidentally capture incorrect values. These should be resolved before opening the pull request. Formatting differences between IDEs are a common issue. It's important to make sure no unexpected or unintended changes were included in the change. If your commit messages are clear and your repository automatically includes commits in the description, this will help provide a starting point.Īdditionally, review the diff before opening the pull request.
#Drupal coders full#
You don't need to copy and paste the ticket description but provide enough information for the reviewer to understand the change (and maybe a link to the full description). Provide any relevant information to establish the context of the change. When opening a new pull request, set the reviewer up for success. The pull request will set the stage for the reviewer. ▢ Ensure that commits have useful messages Opening A Pull Request
▢ Run any linting or standards tools set up for the project ▢ Run a test build to make sure the project builds correctly ▢ Perform appropriate testing and review in multiple browsers ▢ Make sure the change meets the documented requirements ▢ Sync the latest changes from the develop branch The Coder project provides a set of rules for PHP_CodeSniffer to check and apply Drupal coding standards automatically. Make sure the change meets any coding standards that have been established, is well commented on, and the commits show a clear story.
#Drupal coders verification#
A developer doesn't need to be as thorough as the QA team members but a basic level of testing should be applied, including verification in multiple browsers to catch inconsistencies.Īdditionally, this is a good time to help out future developers on the project. The author should review the requirements and ensure the change appropriately addresses them. The code review process begins before the pull request is even opened. Consider if the change meets the requirements in the most efficient manner. Reflecting on the change can offer additional insight into the problem as well as reduce cycle time as the change moves through different stages in the development process. Before submitting a pull request, the author should consider the change from the perspective of other team members, such as the designer, the reviewer, and the QA team. It's also a good point for an author to pause and consider the change they've made. Creating A Pull RequestĪ well-formatted and qualified pull request helps streamline the code review process.
#Drupal coders how to#
We'll describe how to get the most out of your Drupal code reviews by providing a checklist of important steps and criteria for you to return to and reference as you open and review new pull requests. If you've recently started working with Drupal or you are looking to improve your codebase and processes, you may be wondering what you should consider when reviewing changes to your Drupal codebase. Drupal code reviews are an important part of the software development process.
0 kommentar(er)
