Skip to content

Commit

Permalink
Release v2.1.2 (#483)
Browse files Browse the repository at this point in the history
* Run npm audit fix

* Fix footer overflow (#477)

* Run build

* Remove CODEOWNERS because of move ot OIT

* Update meta stuff

* Run build
  • Loading branch information
Blake Morgan authored Jul 30, 2020
1 parent 5ece16c commit d8e62ef
Show file tree
Hide file tree
Showing 10 changed files with 148 additions and 73 deletions.
5 changes: 0 additions & 5 deletions .github/CODEOWNERS

This file was deleted.

9 changes: 7 additions & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
# Contributing

Please fill out the issue template as fully as possible. The more information you give, the easier it will be to fix the problem.
Please fill out the issue template as fully as possible. The more information you give, the easier it will be to fix
the problem.

## Disclaimer

These web components are made by volunteers in the BYU Web Community, so please be patient if we don't get to your issue right away. If it is urgent, feel free to reach out to one of the maintainers. They would be happy to teach you how to fix the issue so you can be a code contributor to this project as well.
These web components are open-source and contributions are welcome. Officially, they are maintained by the OIT BYU Apps
Custom team. Work for that team is prioritized by product owners and will be fixed as time becomes available. If it is
urgent, feel free to reach out in the #byu-apps-custom-comms channel in the BYU-OIT Slack workspace. If you do not have
access to that workspace, ask your CSR to send a message for you. The team would also be happy to teach you how to fix
the issue so that you can be a code contributor to this project.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# byu-theme-components CHANGELOG

## 2.1.2

- Fix footer overflow (#477).

## 2.1.1

- Fix issue with `.active` class on slotted items in the `byu-menu`. (#476)

## 2.1.0

The design was enhanced to better match the styles of websites hosted in Brightspot.
Expand Down
64 changes: 48 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# BYU Core Components
# BYU Theme Components

This repository contains the "core" Web Components implementing the BYU theme.

Specifically, it contains the following components:
* byu-header
* byu-breadcrumbs
* byu-menu
* byu-search
* byu-user-info
Expand All @@ -11,27 +13,57 @@ Specifically, it contains the following components:
* byu-social-media-links
* byu-footer-action-button

In order for a BYU website to be considered compliant with current branding standards it must make use of at least the byu-header and byu-footer components. Additionally, the byu-menu, byu-search, and byu-user-info should be used for the site's primary navigation, search, and login display, if any. The byu-footer-column and byu-footer-action-button are used to add content to the footer if desired. The byu-social-media-links component contains the approved icons for all the major social media platforms and is strongly recommended. Use of unapproved or modified social media icons may violate those platforms' copyright and is not allowed.
In order for a BYU website to be considered compliant with current branding standards it must make use of at least the
byu-header and byu-footer components. Additionally, the byu-menu, byu-search, and byu-user-info should be used for the
site's primary navigation, search, and login display, if any. The byu-footer-column and byu-footer-action-button are
used to add content to the footer if desired. The byu-social-media-links component contains the approved icons for all
the major social media platforms and is strongly recommended. Use of unapproved or modified social media icons may
violate those platforms' copyright and is not allowed.

## Important links
[brand.byu.edu](http://brand.byu.edu) contains a full description of the BYU website branding guidelines

[web.byu.edu](http://web.byu.edu) is the central hub for communication, events, and news relating to the BYU Web Community. It includes a calendar with upcoming events (including WebFests and user group meetings), the proceedings and latest decisions of the Web Advisory Board, and info on the various working groups creating community resources. It also has info on how to join the BYU Web Slack channels.
- [brand.byu.edu](http://brand.byu.edu) contains a full description of the BYU website branding guidelines.
- [webcomponents.byu.edu](https://webcomponents.byu.edu) is all of the public documentation for the web components.

## Getting Started

## Getting Started:
To begin using the components you can visit [the components demo site](http://webcomponents.byu.edu/) for more documentation and code samples. If you're using Drupal or Wordpress, the community has created templates that you can download and install. However, one of the primary goals and benefits of using a web components implementation is that you don't need to use a specific CMS (or any CMS at all) to utilize the components.
To begin using the components you can visit [the components demo site](http://webcomponents.byu.edu/) for more
documentation and code samples. If you're using Drupal or Wordpress, the community has created templates that you can
download and install. However, one of the primary goals and benefits of using a web components implementation is that
you don't need to use a specific CMS (or any CMS at all) to utilize the components.

## CDN Integration
This repository is integrated with the BYU Web Content Delivery Network (cdn) at cdn.byu.edu. This means that every update to the master branch of the repository will be pushed immediately to the cdn, allowing websites across campus to receive the latest updates immediately. More documentation can be found on the [CDN Project Page](https://github.com/byuweb/web-cdn).

## Release Process and Timelines
A new version of these components will be released monthly unless there are no new issues to address. These monthly releases will be either bug-fix releases or minor releases that introduce new features. In addition, if a major bug is discovered we may make an unscheduled release to address it. Releases will use [semver standards](http://semver.org/). Minor and bug-fix releases will maintain backwards compatibility, while major releases could potentially include breaking changes. If a major release is proposed and accepted we will ensure that the BYU web community is given ample time to prepare for any breaking changes and migrate their code accordingly.
This repository is integrated with the BYU Web Content Delivery Network (cdn) at cdn.byu.edu. This means that every
update to the master branch of the repository will be pushed immediately to the cdn, allowing websites across campus to
receive the latest updates immediately. More documentation can be found on the
[CDN Project Page](https://github.com/byuweb/web-cdn).

## Ownership and Releases

These web components are open-source and contributions are welcome. Officially, they are maintained by the OIT BYU Apps
Custom team. Work for that team is prioritized by product owners and will be fixed as time becomes available. If it is
urgent, feel free to reach out in the #byu-apps-custom-comms channel in the BYU-OIT Slack workspace. If you do not have
access to that workspace, ask your CSR to send a message for you. The team would also be happy to teach you how to fix
the issue so that you can be a code contributor to this project.

Releases will use [semver standards](http://semver.org/). Minor and bug-fix releases will maintain backwards
compatibility, while major releases could potentially include breaking changes. If a major release is proposed and
accepted we will ensure that the BYU web community is given ample time to prepare for any breaking changes and migrate
their code accordingly.

## How to Contribute

## How to contribute:
This project is open to the community and we welcome contributions. You can start by [forking this repo](https://help.github.com/articles/fork-a-repo/) and submitting a pull request, though we strongly recommend you also join the slack channel at [byu-web.slack.com](http://byu-web.slack.com) so you can be part of the discussion.
This project is open to the community and we welcome contributions. You can start by
[forking this repo](https://help.github.com/articles/fork-a-repo/) and submitting a pull request, though we strongly
recommend you also join the slack channel at [byu-web.slack.com](http://byu-web.slack.com) so you can be part of the
discussion.

### Our coding standards
Our goal is to implement flexible, well-structured web components according to the latest brand guidelines. Every pull request must be peer-reviewed by one of the project administrators before it can be merged with the master branch. As of this writing we require that any components work properly in at least the 2 latest versions of the following browsers:
### Our Coding Standards
Our goal is to implement flexible, well-structured web components according to the latest brand guidelines. Every pull
request must be peer-reviewed by one of the project administrators before it can be merged with the master branch. As
of this writing we require that any components work properly in at least the 2 latest versions of the following
browsers:

* Chrome
* Firefox
Expand All @@ -41,7 +73,7 @@ Our goal is to implement flexible, well-structured web components according to t
In addition, every component must be responsive, providing a first-class experience to phone and tablet users.

## Favicon
All BYU Websites are encouraged to use the official favicon. This is likely to be located on brand.byu.edu in the future, but it is available now in github: [https://github.com/byuweb/byu-assets/blob/master/favicon.png](https://github.com/byuweb/byu-assets/blob/master/favicon.png).

## Using Github
There's plenty of documentation online about how to work with GitHub and the Git source control system, and there are excellent Git plugins available for most IDEs. If you've never worked with Github before, GitHub has provided some good documentation at [guides.github.com](http://guides.github.com). You can also join the [slack channel](http://byu-web.slack.com) and connect with other developers from the project.
All BYU Websites are encouraged to use the official favicon. This is likely to be located on brand.byu.edu in the
future, but it is available now in github:
[https://github.com/byuweb/byu-assets/blob/master/favicon.png](https://github.com/byuweb/byu-assets/blob/master/favicon.png).
1 change: 0 additions & 1 deletion components/byu-footer/byu-footer.sass
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ $tabletBreak: 1024px // Put exact px to match Brightspot and so info doesn't wor
font-size: 14px
line-height: $fontSize24
color: $white !important
width: 100%
display: flex
justify-content: center
align-items: center
Expand Down
2 changes: 1 addition & 1 deletion dist/byu-theme-components.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit d8e62ef

Please sign in to comment.