Skip to content

Commit a07d2c7

Browse files
authored
Merge pull request #590 from benjaminapetersen/bpeterse/contrib-update
fix(README.md): add examples to Git Commit Guidelines in README.md
2 parents 69502a2 + 33bb8be commit a07d2c7

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,14 +78,14 @@ 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
@@ -95,10 +95,10 @@ Note:
9595

9696
5. (optional) The 'patternfly.charts' module is not a dependency in the default angular 'patternfly' module.
9797
In order to use patternfly charts you must add it as a dependency in your application:
98-
98+
9999
```javascript
100100
my-app.module.js:
101-
101+
102102
angular.module('myApp', [
103103
'patternfly',
104104
'patternfly.charts'
@@ -114,10 +114,10 @@ Note:
114114
115115
6. (optional) The 'patternfly.table' module is not a dependency in the default angular 'patternfly' module.
116116
In order to use pfTableView, you must add 'patternfly.table' as a dependency in your application:
117-
117+
118118
```javascript
119119
my-app.module.js:
120-
120+
121121
angular.module('myApp', [
122122
'patternfly',
123123
'patternfly.table'
@@ -131,13 +131,13 @@ Note:
131131

132132
Add the following CSS includes to your HTML file(s):
133133

134-
134+
135135
```html
136136
<!-- Place before any patternfly css -->
137137
<link rel="stylesheet" href="node_modules/angular-patternfly/node_modules/datatables.net-dt/css/jquery.dataTables.css" />
138138
```
139139
Add the following Javascript includes to your HTML file(s):
140-
140+
141141
```html
142142
<script src="node_modules/angular-patternfly/node_modules/patternfly/node_modules/jquery/dist/jquery.js"></script>
143143
<script src="node_modules/angular-patternfly/node_modules/patternfly/node_modules/datatables.net/js/jquery.dataTables.js"></script>
@@ -147,10 +147,10 @@ Note:
147147
```
148148
7. (optional) The 'patternfly.canvas' module is not a dependency in the default angular 'patternfly' module.
149149
In order to use pfCanvasEditor or pfCanvas, you must add 'patternfly.canvas' as a dependency in your application:
150-
150+
151151
```javascript
152152
my-app.module.js:
153-
153+
154154
angular.module('myApp', [
155155
'patternfly',
156156
'patternfly.canvas'
@@ -165,7 +165,7 @@ Note:
165165
```
166166

167167
Add the following Javascript includes to your HTML file(s):
168-
168+
169169
```html
170170
<!-- jquery before angular.js -->
171171
<script src="node_modules/angular-patternfly/node_modules/patternfly/node_modules/jquery/dist/jquery.js"></script>
@@ -179,7 +179,7 @@ Note:
179179
Also, the canvas background grid image is located in 'node_modules/angular-patternfly/dist/imgs/canvas-dot-grid.png'
180180
please copy this image to your application's main images directory and reference it by overridding the '.canvas' css
181181
class:
182-
182+
183183
```html
184184
<style>
185185
.canvas {
@@ -256,20 +256,31 @@ format that includes a **type**, a **scope** and a **subject** ([full explanatio
256256
257257
```
258258
fix(pencil): stop graphite breaking when too much pressure applied
259+
// Specific example using the component name as the scope
260+
fix(pfEmptyState): add missing closing <span> tag
259261
```
260262
261263
##### Feature Release
262264
263265
```
264266
feat(pencil): add 'graphiteWidth' option
267+
// Specific example using the component name as the scope
268+
feat(pfNotificationDrawer): add empty state message to group without notifications
265269
```
266270
267271
##### Breaking Release
268272
269273
```
270274
perf(pencil): remove graphiteWidth option
275+
// Specific example using the component name as the scope
276+
perf(pfFakeComponent): remove pfFakeComponent
271277
```
272278
279+
##### Non-Release
280+
281+
chore(pencil): rename internal graphiteDensity variable
282+
chore(pfNotificationDrawer): rename internal drawer expanded variable
283+
273284
## Contributing
274285
275286
We're always interested in contributions from the community.
@@ -282,11 +293,11 @@ Please ensure that your PR provides the following:
282293

283294
### Unit Testing Required
284295

285-
Applying a unit test, or an update to a unit test, is a contribution requirement.
296+
Applying a unit test, or an update to a unit test, is a contribution requirement.
286297

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

0 commit comments

Comments
 (0)