Skip to content

Commit

Permalink
updated base files
Browse files Browse the repository at this point in the history
  • Loading branch information
balupton committed Mar 5, 2015
1 parent 5dc21dd commit 2a267e1
Show file tree
Hide file tree
Showing 4 changed files with 45 additions and 13 deletions.
32 changes: 27 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!--
v1.3.22 June 23, 2013
March 5, 2015
https://github.com/bevry/base
-->

Expand Down Expand Up @@ -58,24 +58,46 @@ For project maintainers
``` bash
cake prepublish
```

This will compile the project, run tests, and update any meta files that need updating.


2. Add a changelog entry to `HISTORY.md` with change information

```
v2.0.0 April 17, 2013
- Something that changes
## v2.0.0 April 17, 2013
- Something changed
- Something changed that was referenced in an issue or pull request
- Thanks to [person](https://github.com/person) for [issue #98](https://github.com/project/issue/98)
- Dependency updates
```

3. Update `version` entry in `package.json` with new version number
3. Update `version` entry in `package.json` with a new number that follows semantic versioning

4. Commit changes

``` bash
git commit -a -m "A message about what changed"
git add -u
git add .
git commit -m "A message about what changed"
```

This will stage any updates and any new files for your commit, and commit them with your specified message.


5. Publish new version

``` bash
cake publish
```

This will run `cake prepublish`, publish your project to npm, create a git tag, and push the git updates. It will open your editor for specifying the description for the git tag annotation, use the changelog entry we created before (but without the `##` heading), e.g.

```
v2.0.0 April 17, 2013

- Something changed
- Something changed that was referenced in an issue or pull request
- Thanks to [person](https://github.com/person) for [issue #98](https://github.com/project/issue/98)
- Dependency updates
```
12 changes: 9 additions & 3 deletions LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,16 @@

# License

Copyright &copy; 2012+ Bevry Pty Ltd <us@bevry.me> (http://bevry.me)
<br/>Copyright &copy; 2011 Benjamin Lupton <b@lupton.cc> (http://balupton.com)
Unless stated otherwise all works are:

## The MIT License
- Copyright &copy; 2012+ Bevry Pty Ltd <us@bevry.me> (http://bevry.me)
- Copyright &copy; 2011 Benjamin Lupton <b@lupton.cc> (http://balupton.com)

and licensed under:

- The incredibly [permissive](http://en.wikipedia.org/wiki/Permissive_free_software_licence) [MIT License](http://opensource.org/licenses/mit-license.php)

## MIT License
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
Expand Down
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,14 @@ These amazing people have contributed code to this project:

## License

Licensed under the incredibly [permissive](http://en.wikipedia.org/wiki/Permissive_free_software_licence) [MIT license](http://creativecommons.org/licenses/MIT/)
Unless stated otherwise all works are:

Copyright &copy; 2012+ Bevry Pty Ltd <us@bevry.me> (http://bevry.me)
<br/>Copyright &copy; 2011 Benjamin Lupton <b@lupton.cc> (http://balupton.com)
- Copyright &copy; 2012+ Bevry Pty Ltd <us@bevry.me> (http://bevry.me)
- Copyright &copy; 2011 Benjamin Lupton <b@lupton.cc> (http://balupton.com)

and licensed under:

- The incredibly [permissive](http://en.wikipedia.org/wiki/Permissive_free_software_licence) [MIT License](http://opensource.org/licenses/mit-license.php)

<!-- /LICENSE -->

Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@
},
"devDependencies": {
"docpad": "6",
"coffee-script": "^1.9.0",
"projectz": "^0.4.3"
"coffee-script": "^1.9.1",
"projectz": "^0.5.0"
},
"main": "./out/eco.plugin.js",
"scripts": {
Expand Down

0 comments on commit 2a267e1

Please sign in to comment.