Technical Notes on Contributing Code to WordPress Core

This morning I was contributing some code to WordPress trac. There are a few hard-to-remember-commands and hoops I currently need to jump through. Here they are so I remember for next time.
Context for anyone else who’s reading:

• I’m using Windows 7 and VVV
• because npm doesn’t work well on VVV in shared folders with a Windows machine, I put the WordPress source files in a non-synced folder, and use a symbolic link to have the build files appear in the right folder so they can be accessed over HTTP

I placed the WordPress source files for build.wordpress-develop.test in ~/www/wordpress_develop/develop.git.wordpress.org.
(The first time I was setting it up, I needed to run the new npm and grunt build commands).
From there I run grunt patch:{ticketname} to apply a patch.
I run `grunt watch` to sync the files from `src` to `build` (btw, `build` is actually a symlink to `/srv/www/wordpress-develop/public_html/build` like I described.
To edit the files further, I use PHPStorm ability to open files over SSH (ie, the “Open Project from Existing Files” then select “Web server is on remote host, files are accessible via FTP/SFTP/FTPS”, and then because it’s a vagrant install, the domain is “localhost”, port 2222, and the default vagrant username and password: “vagrant”).
After editing files, I need to remember to select the files I want to upload to the vagrant server by right-clicking on the folder or files and select “Deployment” then “Upload…”.
I may need to double-check PHPStorm is using TABS like requested, and that comments end in periods and have proper punctuation, and there are blank lines between different PHPdoc parameters.
To create the patch for WordPress trac,

1. I like to create a new branch,
2. git checkout -b {ticket-number},
3. then make a commit, git commit -am "message wont appear anywhere",
4. then create the patch with git format-patch  -1 HEAD, which creates the patch file
5. the move the file to a sync’d folder ` mv 0001-add-links-to-filter-sites-in-sites-list-table.patch /srv/www`
6. and usually rename the file to just be the ticket’s number with an extra count in it, like `37392.1.patch`
7. finally I upload the file to the ticket

Double-check that when I go back to working on an Event Espresso project, the code style in PHPstorm goes back to EE’s (I would think different projects would happily have different settings but that hasn’t happened for me yet).
 

Similar Stuff I've Written

Getting Started Contributing Code to WordPress Gutenberg in Laragon How Can We Get More Non-English Speakers Contributing to WordPress? My WordPress and PHP development Setup Five Unspoken Rules of Contributing to Open Source Software Line Ending Troubles with Git, a Virtual Machine, and Windows How to Migrate from a Self-Hosted WordPress Site to WordPress.com Meditation course notes 1 Setup PHPUnit In WordPress Plugins With Composer (Especially for Windows) Are WordPress’ "Small d" Developers Getting Left Behind by “Modern Best Practices”?

Powered by YARPP.