WordPress.org

Make WordPress Core

Opened 3 months ago

Last modified 3 months ago

#46108 new enhancement

Twenty Nineteen: Include contributing.txt file with Sass compiler instructions

Reported by: kjellr Owned by:
Milestone: Awaiting Review Priority: normal
Severity: normal Version: 5.0.3
Component: Bundled Theme Keywords: has-patch
Focuses: Cc:

Description

In the GitHub repository, there is a CONTRIBUTING.md document with instructions for how to compile the Sass for Twenty Nineteen. This file was not migrated over to core.

For those working with the theme (both for direct contributions, and for their own purposes), it'd be helpful to bundle instructions for working with the Sass via the included build tool. The attached patch ports over the "Compiling SCSS" section from the document on GitHub, as a new contributing.txt file.

https://github.com/WordPress/twentynineteen/blob/master/CONTRIBUTING.md#compling-scss

Attachments (3)

46108.patch (1.3 KB) - added by kjellr 3 months ago.
46108-1.diff (1.6 KB) - added by nielslange 3 months ago.
46108-2.patch (1.4 KB) - added by kjellr 3 months ago.

Download all attachments as: .zip

Change History (8)

@kjellr
3 months ago

This ticket was mentioned in Slack in #docs by kjell. View the logs.


3 months ago

@nielslange
3 months ago

#2 @nielslange
3 months ago

@kjellr I made some minor changes, such as changing my-compter to my-computer Apparently, no one noticed this typo yet. 😁

I've also mentioned running grunt build or grunt watch in the WordPress root folder, to compile the changes from /src into /build.

#3 @kjellr
3 months ago

@nielslange Thanks for fixing that typo. 😄

As for the other note:

Please note that you also need to run grunt build or grunt watch within /my-computer/local-wordpress-install/ to compile the changes from /my-computer/local-wordpress-install/src to /my-computer/local-wordpress-install/build.

This may be confusing for some people, as they may be working from a downloaded copy of the theme. I'd either note that this only applies when working directly with core, or eliminate it (it's more of a general core development convention than a theme workflow note anyway).

#4 @nielslange
3 months ago

Sounds good, @kjellr. Feel free to remove my notes again. 😉

@kjellr
3 months ago

#5 @kjellr
3 months ago

Added 46108-2.patch, which removes that line about grunt-build & grunt-watch.

Note: See TracTickets for help on using tickets.