Skip to content

Commit

Permalink
Merge branch 'rc-v0.2.7'
Browse files Browse the repository at this point in the history
  • Loading branch information
cjg89 committed Jan 23, 2019
2 parents 0ef07c6 + 0f70951 commit c59b98c
Show file tree
Hide file tree
Showing 21 changed files with 599 additions and 191 deletions.
4 changes: 4 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Ignore project config json files
package.json
.eslintrc.json
gulp-config.template.json
5 changes: 3 additions & 2 deletions .eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
"env": {
"browser": true,
"es6": true,
"jquery": true
"jquery": true,
"amd": true
},
"globals": {
"Cookies": true,
Expand Down Expand Up @@ -214,7 +215,7 @@
"no-useless-constructor": "error",
"no-useless-rename": "error",
"no-var": "error",
"object-shorthand": "error",
"object-shorthand": ["error", "never"], // MODIFIED webcom
"prefer-arrow-callback": "error",
"prefer-const": "error",
"prefer-numeric-literals": "error",
Expand Down
7 changes: 7 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Users/teams listed below are deemed responsible for the code in this repo.

# Responsible users will automatically be assigned to relevant pull requests
# for this repo.
# See https://help.github.com/articles/about-codeowners/ for more info.

* @UCF/webcom
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
name: "\U0001F41B Bug report"
about: Create a report to help us improve

---

<!--
Thank you for reporting a possible bug in UCF-WordPress-Theme.
Please provide a general summary of the issue in the Title above and fill in as much of the template below as you can.
The version of WordPress can be found on the Admin Dashboard page in the bottom right-hand corner.
The version of this theme can be found by navigating to Appearance > Themes and clicking on Theme Details.
-->

**Describe the bug**
<!--- Provide a more detailed description of the issue you're having -->

**Steps to Reproduce**
<!--- Provide a clear set of steps to reproduce this bug -->
1.
2.
3.
4.

**Expected Behavior**
<!--- Tell us what should happen -->

**Possible Fix**
<!--- Not required: suggest a fix or reason for the bug -->

**Your environment:**
<!-- Include as many relevant details as possible. -->
- Device: [e.g. iPhone6]
- OS: [e.g. iOS]
- Browser & Version [e.g. chrome 68, safari]
- WordPress Version: [e.g. 4.9.8]
- Theme Version: [e.g. 1.5.2]

**Additional context**
<!--- How has this bug affected you? What were you trying to accomplish? Provide a link to a live example or screenshots if available. -->
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: "\U0001F680 Feature request"
about: Suggest an idea for this theme

---

<!--
Thank you for suggesting an idea to make UCF-WordPress-Theme better.
Please provide a general summary of your feature request in the Title above, and fill in as much of the template below as you can.
-->

**Description**
<!-- Provide a detailed description of the change or addition you are proposing -->
<!-- If your feature request is related to a problem you're trying to solve, describe that here as well -->

**Why it's Important**
<!--- Why is this change important to you or your organization? -->
<!--- How can it benefit others who utilize this theme? -->

**Alternatives**
<!-- Please describe alternative solutions or features you've considered -->

**Possible Implementation**
<!--- Not required: suggest an idea for implementing addition or change -->

**Additional context**
<!-- Add any other context or screenshots related to this feature request -->

31 changes: 31 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<!---
Thank you for contributing to UCF-WordPress-Theme.
Please make sure you've read our contributing guidelines:
https://github.com/UCF/UCF-WordPress-Theme/blob/master/CONTRIBUTING.md
Provide a general summary of your changes in the Title above and fill in the template below.
-->

**Description**
<!--- Describe your changes in detail -->

**Motivation and Context**
<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->

**How Has This Been Tested?**
<!--- Please describe how you tested your changes. -->

**Types of changes**
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)

**Checklist:**
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [ ] My code follows the code style of this project.
- [ ] My change requires an update to the documentation.
- [ ] I have updated the documentation accordingly.
10 changes: 5 additions & 5 deletions .sass-lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ rules:
final-newline:
- 1
- include: true
force-attribute-nesting: 1
force-element-nesting: 1
force-pseudo-nesting: 1
force-attribute-nesting: 0 # Modified - allow unnested selectors for more convenient selector overrides
force-element-nesting: 0 # Modified - allow unnested selectors for more convenient selector overrides
force-pseudo-nesting: 0 # Modified - allow unnested selectors for more convenient selector overrides
function-name-format:
- 1
- allow-leading-underscore: true
Expand All @@ -69,7 +69,7 @@ rules:
- 1
- allow-leading-underscore: true
convention: hyphenatedlowercase
mixins-before-declarations: 1
mixins-before-declarations: 0 # Modified - accommodates media query-like mixin includes within blocks
nesting-depth:
- 1
- max-depth: 3
Expand Down Expand Up @@ -137,7 +137,7 @@ rules:
- dppx
- '%'
per-property:
line-height: []
line-height: [] # Modified - always use unitless line-height values
quotes:
- 1
- style: single
Expand Down
167 changes: 167 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,167 @@
# Contributing to the UCF WordPress Theme

Thank you for your interest in contributing to this project! If you are a developer for UCF and want to contribute to this theme, we'd love to hear from you.

This document outlines the best ways to submit new ideas or inform us of bugs. Please take a moment to review these guidelines before submitting new issues or pull requests in order to make the contribution process easy and effective for everyone involved.

## Quick links
* [Using the issue tracker](#using-the-issue-tracker)
* [Bug reports](#bug-reports)
* [Feature requests](#feature-requests)
* [Pull requests](#pull-requests)
* [Asking questions/getting help](#asking-questionsgetting-help)
* [Code standards and style guides](#code-standards-and-style-guides)

-----

## Using the issue tracker

The [issue tracker](https://github.com/UCF/UCF-WordPress-Theme/issues) in Github is the preferred channel for [bug reports](#bug-reports), [feature requests](#feature-requests) and [submitting pull requests](#pull-requests).

Please do not use the issue tracker for personal support requests. The [#help-themes Slack channel](https://ucf-wp.slack.com/messages/help-themes/) is the best place to get help with your project. See the section on [getting help](#asking-questionsgetting-help) for more information.


## Bug reports

A bug is a demonstrable problem that is caused by the code in the repository. Concise and thorough bug reports will help us fix reported problems more quickly and effectively.

### Before submitting a bug report
Before you submit a new bug report, please follow these steps:

1. **Use the GitHub issue search** &mdash; check if the issue has already been reported. Feel free to comment in the existing issue if it is still open and you have new information to share.

2. **Check if the issue has been fixed** &mdash; if you're not running the latest version of the theme, please check your code against the repo's `master` branch first (`master` will always contain the latest, stable project code). If you are running the latest version, make sure the problem isn't already resolved in an upcoming [milestone](https://github.com/UCF/UCF-WordPress-Theme/milestones).

### Submit a bug report
If you've followed the steps above and have a valid bug report to submit, you can submit it by [creating a new issue in Github](https://github.com/UCF/UCF-WordPress-Theme/issues/new?template=bug_report.md).

Add a descriptive, understandable title and details about the bug in the description field, following the template provided. Please try to be as detailed as possible in your report. What steps will reproduce the issue? What browser(s) and OS experience the problem? Do other browsers show the bug differently? What would you expect to be the outcome? All of the information you provide will help us quickly evaluate and fix the issue.

If you have a live example of the bug available somewhere public, please include a link in the bug report. If you're not comfortable including the URL in the Github issue (e.g. it points to a development environment), you can make a note of it in the report (e.g. "see Slack for example URL"), then share the URL in the [#prj-ucf-wp-theme Slack channel](https://ucf-wp.slack.com/messages/prj-ucf-wp-theme/).


## Feature requests

We welcome new feature requests from developers across campus. Before submitting a new request, think carefully about if the proposed feature aligns with the [goals of the project](https://github.com/UCF/UCF-WordPress-Theme/wiki/#project-goals) and with [UCF's brand](https://www.ucf.edu/brand/). We strongly encourage the discussion of new feature ideas in the [ucf-wp Slack workspace](https://ucf-wp.slack.com/).

Please provide as much detail and context as possible to justify the inclusion of your idea in the theme. We reserve the right to deny feature requests when they don't align with the project's goals, or if said feature is already accomplishable with existing utilities/components.

You can submit a new feature request by [creating a new issue in Github](https://github.com/UCF/UCF-WordPress-Theme/issues/new?template=feature_request.md) and filling out the provided template.


## Pull requests

[**Please ask first**](#asking-questionsgetting-help) before embarking on any _significant_ pull request (e.g. implementing features, refactoring code); otherwise you risk spending a lot of time working on something that the theme's maintainers might not want to merge into the project. Pull requests should be related to existing issues that have been acknowledged by UCF Web Communications.

All pull requests should remain focused in scope and avoid containing unrelated commits.

Your pull request will be reviewed by at least one maintainer of the theme. While your code should be complete enough to be understood by the person reviewing it, we don't want to spend an extensive amount of time reviewing code--try to keep your code sample brief enough to be reviewed within one hour.

Please adhere to the [coding guidelines](#code-standards-and-style-guides) used throughout the project (indentation, accurate comments, etc.) Code that does not adhere to these standards will not be merged into the project.

### How to submit a pull request

Adhering to the following process is the best way to submit a pull request:

1. [Fork](https://help.github.com/articles/fork-a-repo/) the project.
2. Clone your fork, and configure the remotes:

```bash
# Clone your fork of the repo into the current directory
git clone https://github.com/<your-username>/UCF-WordPress-Theme.git

# Navigate to the newly cloned directory
cd UCF-WordPress-Theme

# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/UCF/UCF-WordPress-Theme.git
```

3. If you cloned a while ago, get the latest changes from upstream:

```bash
git checkout master
git pull upstream master
```

4. Create a new topic branch to contain your feature, change, or fix.

```bash
git checkout -b <topic-branch-name>
```

New branches **must** be branched off of the most recent existing `rc-*` branch (typically there will only be one open at a time), or off of `master` directly if no `rc-*` branch exists.

**Never create _any_ new branch from the `develop` branch**--`develop` exists solely for project maintainers' usage and is considered a "dirty" branch. **Branches created from `develop` will not be merged into the project.**
5. Commit your changes in logical chunks. Please provide [helpful, readable commit messages](https://chris.beams.io/posts/git-commit/) (avoid nondescriptive messages such as "bugfix" or "minor change").
If you're making changes to scss or js files, make sure you're minifying **and committing** those minified file changes. scss and js file processing should be performed using gulp commands provided in the repo (see [gulpfile.js](https://github.com/UCF/UCF-WordPress-Theme/blob/master/gulpfile.js))
6. Locally merge the upstream `rc-*` or `master` branch (whichever you branched off of initially) into your topic branch:
```bash
git merge --no-ff upstream master
```
7. Push your topic branch up to your fork:
```bash
git push origin <topic-branch-name>
```
8. [Open a Pull Request](https://help.github.com/articles/about-pull-requests/) against the `rc-*` or `master` branch (whichever you initially branched off of.) Pull request titles and descriptions should be as descriptive and clear as possible.
-----
## Asking questions/getting help
In general, we keep conversations about distributed UCF WordPress projects on the [ucf-wp Slack workspace](https://ucf-wp.slack.com/). This workspace is owned and managed by UCF Web Communications (Webcom). You'll need a **@ucf.edu** email address to join.

Whenever you post to the ucf-wp Slack, including your **job title**, information about the **college or department** you work for, as well as the **site(s) you need help with** will help us help you more effectively.

### General questions
If you have a general question about the theme, design decisions, or any other question that isn't a help request, please post it in the [#prj-ucf-wp-theme Slack channel](https://ucf-wp.slack.com/messages/prj-ucf-wp-theme/).
### Help
If you need help with using this theme on your site, check out our [project documentation](https://github.com/UCF/UCF-WordPress-Theme/wiki). If you can't find the answer to your question there, please drop us a line in the [#help-themes Slack channel](https://ucf-wp.slack.com/messages/help-themes/). You don't need to @mention anyone specific, but **please note that you're using the UCF WordPress Theme when posting your question** and include a link to your site if it's relevant to your question.

-----

## Code standards and style guides

Whenever you add or modify code in this repo, please follow the code style guides noted below, per language:

### PHP

[Adhere to the WordPress PHP Coding Standards](https://make.wordpress.org/core/handbook/best-practices/coding-standards/php/) for new or modified code.

### HTML

[Adhere to the mdo Code Guide.](http://codeguide.co/#html)

- Use tags and elements appropriate for an HTML5 doctype (e.g., self-closing tags).
- Use CDNs and HTTPS when referencing third-party JS.
- Use [WAI-ARIA](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA) attributes when appropriate to promote accessibility.

### CSS/Sass

Adhere to the [mdo Code Guide](http://codeguide.co/#css) for basic CSS formatting guidelines, except for what's noted below.

Use [CSS-Tricks' Sass Style Guide](https://css-tricks.com/sass-style-guide/) for Sass-specific features (e.g. order of extends, mixin inclusions, etc in a ruleset).
- Declaration order: declarations should be in alphabetical order.
- Selectors: all selectors in a ruleset should be on their own line.
- All generated color pallettes and font sizes/weights should comply with [WCAG 2.0 AA contrast guidelines](https://www.w3.org/TR/WCAG20/#visual-audio-contrast) in their default state. Components and utilities with hover/focus/active states should try to comply with these contrast requirements whenever possible.
- Except in rare cases, don't remove default `:focus` styles (via e.g. `outline: none;`) without providing alternative styles. See [this A11Y Project post](http://a11yproject.com/posts/never-remove-css-outlines/) for more details.

New/modified Sass code should not throw any Sass-lint errors. We recommend using a [Sass-lint integration with your IDE of choice](https://www.npmjs.com/package/sass-lint#ide-integration) to show linter warnings/errors as you code. This repo includes a Sass-lint config file with the desired linter rulesets for this project.

### JS

[Adhere to the jQuery Coding Standards and Best Practices](http://lab.abhinayrathore.com/jquery-standards/).

- 2 spaces (no tabs)
- Don't use [jQuery event alias convenience methods](https://github.com/jquery/jquery/blob/master/src/event/alias.js) (such as `$().focus()`). Instead, use [`$().trigger(eventType, ...)`](https://api.jquery.com/trigger/) or [`$().on(eventType, ...)`](https://api.jquery.com/on/), depending on whether you're firing an event or listening for an event. (For example, `$().trigger('focus')` or `$().on('focus', function (event) { /* handle focus event */ })`) We do this to be compatible with custom builds of jQuery where the event aliases module has been excluded.
New/modified JavaScript code should not throw any eslint errors. We recommend using a [eslint integration with your IDE of choice](https://eslint.org/docs/user-guide/integrations#editors) to show linter warnings/errors as you code. This repo includes an eslint config file with the desired linter rulesets for this project.
3 changes: 3 additions & 0 deletions functions.php
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
<?php
// Activation checks
include_once 'includes/activate.php';

// Theme foundation
include_once 'includes/utilities.php';
include_once 'includes/config.php';
Expand Down
2 changes: 1 addition & 1 deletion gulp-config.template.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"sync": false,
"syncTarget": "http://localhost/wordpress/main-site/"
"syncTarget": "http://localhost/wordpress/"
}
Loading

0 comments on commit c59b98c

Please sign in to comment.