You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Please fill out the issue template as fully as possible. The more information you give, the easier it will be to fix the problem.
3
+
Please fill out the issue template as fully as possible. The more information you give, the easier it will be to fix
4
+
the problem.
4
5
5
6
## Disclaimer
6
7
7
-
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.
8
+
These web components are open-source and contributions are welcome. Officially, they are maintained by the OIT BYU Apps
9
+
Custom team. Work for that team is prioritized by product owners and will be fixed as time becomes available. If it is
10
+
urgent, feel free to reach out in the #byu-apps-custom-comms channel in the BYU-OIT Slack workspace. If you do not have
11
+
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
12
+
the issue so that you can be a code contributor to this project.
This repository contains the "core" Web Components implementing the BYU theme.
3
4
4
5
Specifically, it contains the following components:
5
6
* byu-header
7
+
* byu-breadcrumbs
6
8
* byu-menu
7
9
* byu-search
8
10
* byu-user-info
@@ -11,27 +13,57 @@ Specifically, it contains the following components:
11
13
* byu-social-media-links
12
14
* byu-footer-action-button
13
15
14
-
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.
16
+
In order for a BYU website to be considered compliant with current branding standards it must make use of at least the
17
+
byu-header and byu-footer components. Additionally, the byu-menu, byu-search, and byu-user-info should be used for the
18
+
site's primary navigation, search, and login display, if any. The byu-footer-column and byu-footer-action-button are
19
+
used to add content to the footer if desired. The byu-social-media-links component contains the approved icons for all
20
+
the major social media platforms and is strongly recommended. Use of unapproved or modified social media icons may
21
+
violate those platforms' copyright and is not allowed.
15
22
16
23
## Important links
17
-
[brand.byu.edu](http://brand.byu.edu) contains a full description of the BYU website branding guidelines
18
24
19
-
[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.
25
+
-[brand.byu.edu](http://brand.byu.edu) contains a full description of the BYU website branding guidelines.
26
+
-[webcomponents.byu.edu](https://webcomponents.byu.edu) is all of the public documentation for the web components.
27
+
28
+
## Getting Started
20
29
21
-
## Getting Started:
22
-
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.
30
+
To begin using the components you can visit [the components demo site](http://webcomponents.byu.edu/) for more
31
+
documentation and code samples. If you're using Drupal or Wordpress, the community has created templates that you can
32
+
download and install. However, one of the primary goals and benefits of using a web components implementation is that
33
+
you don't need to use a specific CMS (or any CMS at all) to utilize the components.
23
34
24
35
## CDN Integration
25
-
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).
26
36
27
-
## Release Process and Timelines
28
-
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.
37
+
This repository is integrated with the BYU Web Content Delivery Network (cdn) at cdn.byu.edu. This means that every
38
+
update to the master branch of the repository will be pushed immediately to the cdn, allowing websites across campus to
39
+
receive the latest updates immediately. More documentation can be found on the
These web components are open-source and contributions are welcome. Officially, they are maintained by the OIT BYU Apps
45
+
Custom team. Work for that team is prioritized by product owners and will be fixed as time becomes available. If it is
46
+
urgent, feel free to reach out in the #byu-apps-custom-comms channel in the BYU-OIT Slack workspace. If you do not have
47
+
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
48
+
the issue so that you can be a code contributor to this project.
49
+
50
+
Releases will use [semver standards](http://semver.org/). Minor and bug-fix releases will maintain backwards
51
+
compatibility, while major releases could potentially include breaking changes. If a major release is proposed and
52
+
accepted we will ensure that the BYU web community is given ample time to prepare for any breaking changes and migrate
53
+
their code accordingly.
54
+
55
+
## How to Contribute
29
56
30
-
## How to contribute:
31
-
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.
57
+
This project is open to the community and we welcome contributions. You can start by
58
+
[forking this repo](https://help.github.com/articles/fork-a-repo/) and submitting a pull request, though we strongly
59
+
recommend you also join the slack channel at [byu-web.slack.com](http://byu-web.slack.com) so you can be part of the
60
+
discussion.
32
61
33
-
### Our coding standards
34
-
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:
62
+
### Our Coding Standards
63
+
Our goal is to implement flexible, well-structured web components according to the latest brand guidelines. Every pull
64
+
request must be peer-reviewed by one of the project administrators before it can be merged with the master branch. As
65
+
of this writing we require that any components work properly in at least the 2 latest versions of the following
66
+
browsers:
35
67
36
68
* Chrome
37
69
* Firefox
@@ -41,7 +73,7 @@ Our goal is to implement flexible, well-structured web components according to t
41
73
In addition, every component must be responsive, providing a first-class experience to phone and tablet users.
42
74
43
75
## Favicon
44
-
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).
45
76
46
-
## Using Github
47
-
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.
77
+
All BYU Websites are encouraged to use the official favicon. This is likely to be located on brand.byu.edu in the
0 commit comments