Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds instructions for patching contrib modules #9

Merged
merged 2 commits into from
Aug 11, 2020
Merged

Adds instructions for patching contrib modules #9

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
384d27e
Adds instructions for patching contrib modules
Aug 7, 2020
c6db1eb
Update README.md
Aug 8, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,27 @@ lando create-patch

This will output a patch file to `/app/web/ISSUE####-COMMENT#.patch`, which you can upload to the drupal.org issue.

#### Contrib Module

To create a patch for a contrib module, for example [Admin Toolbar](https://www.drupal.org/project/admin_toolbar), download it to the modules folder, following the instructions under [Version control](https://www.drupal.org/project/admin_toolbar/git-instructions):

```
cd web/modules
git clone --branch 8.x-2.x https://git.drupalcode.org/project/admin_toolbar.git
```
Inside the contrib module folder, create a branch in the format `ISSUE####-COMMENT#.patch`:

```
cd admin_toolbar
git checkout -b 1234567-admin_toolbar-improved-paths
```
When you are ready to create the patch, add any new files and updates to existing files, and create the patch:

```
git add -A
git diff 1234567-admin_toolbar-improved-paths > 1234567-admin_toolbar-improved-paths.patch
```

## Running Tests

When you create a patch you may have written tests for it that you want to run. At a minimum you'll want to run the tests for the module the patch is for to make sure your changes have not introduced regressions. To run the tests use the `lando test` command. To see what you can do use:
Expand Down