diff --git a/docroot/themes/humsci/humsci_basic/humsci-theme-diagram.png b/docroot/themes/humsci/humsci_basic/humsci-theme-diagram.png index 31627fa68..f4cdb30a4 100644 Binary files a/docroot/themes/humsci/humsci_basic/humsci-theme-diagram.png and b/docroot/themes/humsci/humsci_basic/humsci-theme-diagram.png differ diff --git a/docroot/themes/humsci/humsci_basic/readme.md b/docroot/themes/humsci/humsci_basic/readme.md index 3cecd8fd2..fc4de44eb 100644 --- a/docroot/themes/humsci/humsci_basic/readme.md +++ b/docroot/themes/humsci/humsci_basic/readme.md @@ -1,13 +1,13 @@ # Humsci Basic (humsci_basic) Theme -Humsci Basic (humsci_basic) is a theme that can be used as a base for future H&S themes. We have pulled patterns and templates for Humsci Basic from Stanford Basic (stanford_basic) and Stanford University Humsci Theme (su_humsci_theme) Themes. Humsci Basic integrates selectively with Decanter (v6) Sass, styles, and patterns. +Humsci Basic (humsci_basic) is a theme that can be used as a base for future H&S themes. We have pulled patterns and templates for Humsci Basic from Stanford Basic (stanford_basic) Theme. Humsci Basic integrates selectively with Decanter (v6) Sass, styles, and patterns. ![Humsci Theme Diagrams](humsci-theme-diagram.png) ## Requirements -- Drupal 8.7.10 -- Node 10.15+ +- Drupal 10.3.0 +- Node 22 ## Sub-themes @@ -28,7 +28,7 @@ This theme contains its own node module dependencies and build system which is s Frontend assets are built using the Grunt task runner, but are run using npm scripts as shortcuts. CSS assets are compiled to their respective child theme `css/` directory. JS assets are compiled to the `scripts/build/scripts.js` file. - `npm start` - Runs the build task followed by the watch task -- `npm run build` - Compile Sass and JS for production +- `npm run build` - Compile Sass and JS for production - `npm run watch` - Compile a CSS and JS build and watch for changes in the existing `.scss` or `.js` files ### Browserslist @@ -66,7 +66,7 @@ We use the [Sass True](https://github.com/oddbird/true) testing framework to tes ### Linting -We use [stylelint](https://stylelint.io/) to lint all of our Sass code to maintain a consistent code style. +We use [stylelint](https://stylelint.io/) to lint all of our Sass code to maintain a consistent code style. To test it you can run: `npm run lint:sass` Our linting rules use the [Sparkbox Stylelint Config](https://github.com/sparkbox/stylelint-config-sparkbox) as a base for our linting rules. @@ -106,22 +106,24 @@ _Note: Differences in content will also be reported as failures. Some failures c To make it easier to find work being done we should use the following naming conventions: ### Branch Names: -`STN-XXX--descriptive-message` +`SHS-XXX--descriptive-message` #### Commit Messages: -`feat(STN-XXX): descriptive message shorter than 80 chars` -`fix(STN-XXX): descriptive message shorter than 80 chars` -`refactor(STN-XXX): descriptive message shorter than 80 chars` -`chore(STN-XXX): descriptive message shorter than 80 chars` -`docs(STN-XXX): descriptive message shorter than 80 chars` +`feat(SHS-XXX): descriptive message shorter than 80 chars` +`fix(SHS-XXX): descriptive message shorter than 80 chars` +`refactor(SHS-XXX): descriptive message shorter than 80 chars` +`chore(SHS-XXX): descriptive message shorter than 80 chars` +`docs(SHS-XXX): descriptive message shorter than 80 chars` https://www.conventionalcommits.org/en/v1.0.0-beta.2/ #### Pull Request Titles: -`STN-XXX: Short Descriptive Titles` +`SHS-XXX: Short Descriptive Titles` Pull request descriptions should follow the PR template that is generated when creating a new commit. +There's a Tugboat implementation that build previews for some sites to help reviewing the work done in the PR. + #### Green Button Merging: After receiving a review and getting a PR approved, we do green-button merges for our PRs ("Rebase and Merge") because Github includes a link to the PR in our commit message header. @@ -129,7 +131,7 @@ After receiving a review and getting a PR approved, we do green-button merges fo This theme aims to **partially** integrate [Decanter](https://github.com/SU-SWS/decanter). Instead of rendering all the styles generated by Decanter we: -- Import variables, function and mixins +- Import some variables, function and mixins - Compile various helpers classes - Compile specific components such as Brand Bar, Logo, Lockup and Footer