Skip to content

Commit 33bb8be

Browse files
fix(README.md): add examples to Git Commit Guidelines in README.md
1 parent a91312c commit 33bb8be

File tree

1 file changed

+30
-19
lines changed

1 file changed

+30
-19
lines changed

Diff for: README.md

+30-19
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
[![Join the chat at https://gitter.im/patternfly/angular-patternfly](https://badges.gitter.im/patternfly/angular-patternfly.svg)](https://gitter.im/patternfly/angular-patternfly?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
66

7-
# AngularJS directives for [PatternFly](https://www.patternfly.org)
7+
# AngularJS components for [PatternFly](https://www.patternfly.org)
88

9-
This project will provide a set of common AngularJS directives for use with the PatternFly reference implementation.
9+
This project will provide a set of common AngularJS components for use with the PatternFly reference implementation.
1010

1111
* Web site: https://www.patternfly.org
1212
* API Docs: http://www.patternfly.org/angular-patternfly/#/api
@@ -18,7 +18,7 @@ You have to install required software before you're able to use grunt:
1818

1919
* Install Node.js - Find more information on [Node.js](http://nodejs.org/)
2020

21-
Angular Patternfly stays up to date with the Node LTS [Release Schedule](https://github.com/nodejs/LTS#lts_schedule). If you're using Angular Patternfly downstream, we suggest the use of an actively supported version of Node/NPM, although prior versions of Node may work.
21+
Angular Patternfly stays up to date with the Node LTS [Release Schedule](https://github.com/nodejs/LTS#lts_schedule). If you're using Angular Patternfly downstream, we suggest the use of an actively supported version of Node/NPM, although prior versions of Node may work.
2222

2323
* Install npm - If npm is not already installed with Node.js, you have to install it manually. Find more information on [NPM](https://www.npmjs.org/)
2424

@@ -55,7 +55,7 @@ Note:
5555
2. Add the core Patternfly CSS and script includes to your HTML file(s):
5656

5757
Please see: https://github.com/patternfly/patternfly/blob/master/QUICKSTART.md
58-
58+
5959
Alternatively, the minimum you will need:
6060

6161
<!-- PatternFly Styles -->
@@ -78,24 +78,24 @@ Note:
7878
```html
7979
<!-- Angular -->
8080
<script src="node_modules/angular-patternfly/node_modules/angular/angular.min.js"></script>
81-
81+
8282
<!-- Angular-Bootstrap -->
8383
<script src="node_modules/angular-patternfly/node_modules/angular-ui-bootstrap/dist/ui-bootstrap.js"></script>
8484
<script src="node_modules/angular-patternfly/node_modules/angular-ui-bootstrap/dist/ui-bootstrap-tpls.js"></script>
85-
85+
8686
<!-- Angular-Sanitize -->
8787
<script src="node_modules/angular-patternfly/node_modules/angular-sanitize/angular-sanitize.min.js"></script>
88-
88+
8989
<!-- Angular-PatternFly -->
9090
<script src="node_modules/angular-patternfly/dist/angular-patternfly.min.js"></script>
9191
```
9292

9393
5. (optional) The 'patternfly.charts' module is not a dependency in the default angular 'patternfly' module.
9494
In order to use patternfly charts you must add it as a dependency in your application:
95-
95+
9696
```javascript
9797
my-app.module.js:
98-
98+
9999
angular.module('myApp', [
100100
'patternfly',
101101
'patternfly.charts'
@@ -111,10 +111,10 @@ Note:
111111
112112
6. (optional) The 'patternfly.table' module is not a dependency in the default angular 'patternfly' module.
113113
In order to use pfTableView, you must add 'patternfly.table' as a dependency in your application:
114-
114+
115115
```javascript
116116
my-app.module.js:
117-
117+
118118
angular.module('myApp', [
119119
'patternfly',
120120
'patternfly.table'
@@ -128,13 +128,13 @@ Note:
128128

129129
Add the following CSS includes to your HTML file(s):
130130

131-
131+
132132
```html
133133
<!-- Place before any patternfly css -->
134134
<link rel="stylesheet" href="node_modules/angular-patternfly/node_modules/datatables.net-dt/css/jquery.dataTables.css" />
135135
```
136136
Add the following Javascript includes to your HTML file(s):
137-
137+
138138
```html
139139
<script src="node_modules/angular-patternfly/node_modules/patternfly/node_modules/jquery/dist/jquery.js"></script>
140140
<script src="node_modules/angular-patternfly/node_modules/patternfly/node_modules/datatables.net/js/jquery.dataTables.js"></script>
@@ -144,10 +144,10 @@ Note:
144144
```
145145
7. (optional) The 'patternfly.canvas' module is not a dependency in the default angular 'patternfly' module.
146146
In order to use pfCanvasEditor or pfCanvas, you must add 'patternfly.canvas' as a dependency in your application:
147-
147+
148148
```javascript
149149
my-app.module.js:
150-
150+
151151
angular.module('myApp', [
152152
'patternfly',
153153
'patternfly.canvas'
@@ -162,7 +162,7 @@ Note:
162162
```
163163

164164
Add the following Javascript includes to your HTML file(s):
165-
165+
166166
```html
167167
<!-- jquery before angular.js -->
168168
<script src="node_modules/angular-patternfly/node_modules/patternfly/node_modules/jquery/dist/jquery.js"></script>
@@ -176,7 +176,7 @@ Note:
176176
Also, the canvas background grid image is located in 'node_modules/angular-patternfly/dist/imgs/canvas-dot-grid.png'
177177
please copy this image to your application's main images directory and reference it by overridding the '.canvas' css
178178
class:
179-
179+
180180
```html
181181
<style>
182182
.canvas {
@@ -253,20 +253,31 @@ format that includes a **type**, a **scope** and a **subject** ([full explanatio
253253
254254
```
255255
fix(pencil): stop graphite breaking when too much pressure applied
256+
// Specific example using the component name as the scope
257+
fix(pfEmptyState): add missing closing <span> tag
256258
```
257259
258260
##### Feature Release
259261
260262
```
261263
feat(pencil): add 'graphiteWidth' option
264+
// Specific example using the component name as the scope
265+
feat(pfNotificationDrawer): add empty state message to group without notifications
262266
```
263267
264268
##### Breaking Release
265269
266270
```
267271
perf(pencil): remove graphiteWidth option
272+
// Specific example using the component name as the scope
273+
perf(pfFakeComponent): remove pfFakeComponent
268274
```
269275
276+
##### Non-Release
277+
278+
chore(pencil): rename internal graphiteDensity variable
279+
chore(pfNotificationDrawer): rename internal drawer expanded variable
280+
270281
## Contributing
271282
272283
We're always interested in contributions from the community.
@@ -279,11 +290,11 @@ Please ensure that your PR provides the following:
279290

280291
### Unit Testing Required
281292

282-
Applying a unit test, or an update to a unit test, is a contribution requirement.
293+
Applying a unit test, or an update to a unit test, is a contribution requirement.
283294

284295
If you're unfamiliar with Angular unit testing, or just need a refresher, here
285296
are the overall [Angular 1x guidelines](https://docs.angularjs.org/guide/unit-testing).
286-
297+
287298
You can access the Angular PatternFly unit test ```spec``` files under the ```test``` directory.
288299
289300
To get started, some basic guidelines:

0 commit comments

Comments
 (0)