Skip to content

Commit cf7da96

Browse files
committed
Merge pull request #25 from js-data/v3
V3
2 parents 142a1be + 4e49b86 commit cf7da96

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+3255
-3339
lines changed

.bowerrc

Lines changed: 0 additions & 3 deletions
This file was deleted.

.github/CONTRIBUTING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Contributing to js-data-firebase
2+
3+
[Read the general Contributing Guide](http://js-data.io/docs/contributing).
4+
5+
## Project structure
6+
7+
* `dist/` - Contains final build files for distribution
8+
* `doc/` - Output folder for JSDocs
9+
* `src/` - Project source code
10+
* `test/` - Project tests
11+
12+
## Clone, build & test
13+
14+
1. `clone [email protected]:js-data/js-data-firebase.git`
15+
1. `cd js-data-firebase`
16+
1. `npm install`
17+
1. `npm test` - Lint, build, and test
18+
19+
## To cut a release
20+
21+
1. Checkout master
22+
1. Bump version in `package.json` appropriately
23+
1. Update `CHANGELOG.md` appropriately
24+
1. Run `npm run release`
25+
1. Commit and push changes
26+
1. Checkout `release`, merge `master` into `release`
27+
1. Run `npm run release` again
28+
1. Commit and push changes
29+
1. Make a GitHub release
30+
- tag from `release` branch
31+
- set tag name to version
32+
- set release name to version
33+
- set release body to changelog entry for the version
34+
1. `npm publish .`
35+
36+
See also [Community & Support](http://js-data.io/docs/community).

.github/ISSUE_TEMPLATE.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
(delete this line) Find out how to get help here: http://js-data.io/docs/community.
2+
3+
<your detailed, actionable, and helpful text goes here>
4+
5+
Thanks!

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Fixes #<issue_number_goes_here> (it's a good idea to open an issue first for discussion)
2+
3+
- [ ] - `npm test` succeeds
4+
- [ ] - Code coverage does not decrease (if any source code was changed)
5+
- [ ] - Appropriate JSDoc comments were updated in source code (if applicable)
6+
- [ ] - Approprate changes to js-data.io docs have been suggested ("Suggest Edits" button)

.gitignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,10 @@ bower_components/
66
*.iml
77

88
coverage/
9+
10+
npm-debug.log
11+
junit/
12+
dist/karma.start.js
13+
doc/
14+
typings/
15+
.vscode

.jshintrc

Lines changed: 0 additions & 33 deletions
This file was deleted.

.mailmap

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Jason Dobry <[email protected]> Jason Dobry <[email protected]>

AUTHORS

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# This is the official list of js-data-firebase project authors.
2+
#
3+
# This file is controlled by scripts/authors.js
4+
#
5+
# Names are formatted as:
6+
# # commits Name or Organization <email address>
7+
# The email address is not required for organizations.
8+
Jason Dobry <[email protected]>
9+
Overall, Matthew <[email protected]>
10+
Tianxiang Chen <[email protected]>

CHANGELOG.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,37 @@
1+
##### 3.0.0-beta.1 - 03 May 2016
2+
3+
Official v3 beta release
4+
5+
###### Breaking changes
6+
- Now depends on js-data v3
7+
- How you must now import in ES2015:
8+
9+
```js
10+
import FirebaseAdapter from 'js-data-firebase'
11+
const adapter = new FirebaseAdapter({ basePath: '<your-firebase-url>' })
12+
```
13+
or
14+
```js
15+
import {FirebaseAdapter, version} from 'js-data-firebase'
16+
console.log(version)
17+
const adapter = new FirebaseAdapter()
18+
```
19+
20+
- How you must now import in ES5:
21+
22+
```js
23+
var JSDataFirebase = require('js-data-firebase')
24+
var FirebaseAdapter = JSDataFirebase.FirebaseAdapter
25+
var adapter = new FirebaseAdapter({ basePath: '<your-firebase-url>' })
26+
```
27+
28+
- Moved some `dist` files to `release` to reduce noise
29+
30+
###### Other
31+
- Upgraded dependencies
32+
- Improved JSDoc comments
33+
- Now using js-data JSDoc template
34+
135
##### 2.1.1 - 10 July 2015
236

337
###### Backwards compatible bug fixes

CONTRIBUTING.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

CONTRIBUTORS

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# People who have contributed to the js-data-firebase project.
2+
#
3+
# This file is controlled by scripts/authors.js
4+
#
5+
# Names should be added to this file as:
6+
# [commit count] Name <email address>
7+
63 Jason Dobry <[email protected]>

Gruntfile.js

Lines changed: 0 additions & 140 deletions
This file was deleted.

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2014-2015 Jason Dobry
3+
Copyright (c) 2014-2016 js-data-firebase project authors
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

0 commit comments

Comments
 (0)