Skip to content

Commit

Permalink
v5.0.0. Improvement.
Browse files Browse the repository at this point in the history
  • Loading branch information
balupton committed Apr 7, 2015
1 parent 5d9e1ac commit cc6a806
Show file tree
Hide file tree
Showing 11 changed files with 390 additions and 291 deletions.
3 changes: 2 additions & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# v1.3.18 June 8, 2014
# 8 June 2014
# https://github.com/bevry/base

root = true

[*]
Expand Down
11 changes: 8 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,16 +1,21 @@
# March 15, 2015
# 27 March 2015
# https://github.com/bevry/base

# Temp Files
**/*.log
**/.docpad.db
**/out.*
**/*.log
**/*.cpuprofile
**/*.heapsnapshot

# Build Files
build/
components/
bower_components/
node_modules/
out/
coffeejs/
es5/

# Editor Caches
.c9/
Expand All @@ -22,6 +27,6 @@ out/


# =====================================
# CUSTOM MODIFICATIONS
# CUSTOM

# None
7 changes: 5 additions & 2 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
# v1.3.23 October 11, 2014
# 27 March 2015
# https://github.com/bevry/base

# Temp Files
**/*.log
**/.docpad.db
**/out.*
**/*.log
**/*.cpuprofile
**/*.heapsnapshot

# Build Files
build/
Expand Down
11 changes: 11 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,19 @@ cache:
directories:
- node_modules
notifications:
# Notify #bevry-dev
irc:
- "irc.freenode.org#bevry-dev"

# Nofity travisci@bevry.me
email:
recipients:
- travisci@bevry.me

# Notify https://gitter.im/bevry
webhooks:
urls:
- "https://webhooks.gitter.im/e/d2884017c0c4b0319adc"
on_success: always # options: [always|never|change] default: always
on_failure: always # options: [always|never|change] default: always
on_start: false # default: false
155 changes: 96 additions & 59 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,103 +1,140 @@
<!--
March 5, 2015
April 5, 2015
https://github.com/bevry/base
-->

# Before You Post!

# Contribute
## Support

We offer support through our [Official Support Channels](https://discuss.bevry.me/t/official-bevry-support-channels/63). Do not use GitHub Issues for support, your issue will be closed.

## Resources

- [Coding Standards](http://learn.bevry.me/community/coding-standards)
- [Documentation Guidelines](http://learn.bevry.me/community/documentation-guidelines)
- [Support Guidelines](http://learn.bevry.me/community/support-guidelines)
## Contribute

Our [Contributing Guide](https://learn.bevry.me/community/contribute) contains useful tips and suggestions for how to contribute to this project, it's worth the read.


## Development

For developers and contributors
### Setup

1. Fork project and clone your fork
1. Install [Node.js](/node/install)

2. Install global dependencies
1. Fork the project and clone your fork - [guide](https://help.github.com/articles/fork-a-repo/)

``` bash
npm install -g coffee-script
```
1. Install local dependencies

3. Install local dependencies
``` bash
npm install
```

``` bash
cake install
```
1. Perform any other setup operations

4. Compile project
``` bash
npm run-script setup
```


### Developing

- Compiling changes

``` bash
# Only once
cake compile
npm run-script compile
# On every change
cake watch
npm run-script watch
```

5. Run tests

``` bash
cake test
npm run-script verify
```


## Publishing
### Publishing

For project maintainers
Follow these steps in order to implement your changes/improvements into your desired project:

1. Update meta files with latest information

``` bash
cake prepublish
```

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

1. Make sure your changes are on their own branch that is branched off from master.
1. You can do this by: `git checkout master; git checkout -b your-new-branch`
1. And push the changes up by: `git push origin your-new-branch`

2. Add a changelog entry to `HISTORY.md` with change information
1. Ensure all tests pass:

```
## 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
```
``` bash
npm run-script verify
```

3. Update `version` entry in `package.json` with a new number that follows semantic versioning
> If possible, add tests for your change, if you don't know how, mention this in your pull request

4. Commit changes
1. Ensure the project is ready for publishing:

``` bash
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.
```
git status
git diff
npm run-script prepare
```


5. Publish new version
#### Pull Request

``` bash
cake publish
```
To send your changes for the project owner to merge in:

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
```
1. Submit your pull request
1. When submitting, if the original project has a `dev` or `integrate` branch, use that as the target branch for your pull request instead of the default `master`
1. By submitting a pull request you agree for your changes to have the same license as the original plugin


#### Publish

To publish your changes as the project owner:

1. Switch to the master branch:

``` bash
git checkout master
```

1. Merge in the changes of the feature branch (if applicable)

1. Increment the version number in the `package.json` file according to the [semantic versioning](http://semver.org) standard, that is:
1. `x.0.0` MAJOR version when you make incompatible API changes (note: DocPad plugins must use v2 as the major version, as v2 corresponds to the current DocPad v6.x releases)
1. `x.y.0` MINOR version when you add functionality in a backwards-compatible manner
1. `x.y.z` PATCH version when you make backwards-compatible bug fixes

1. Add an entry to the changelog following the format of the previous entries, an example of this is:

``` markdown
- v6.29.0 April 1, 2013
- Progress on [issue #474](https://github.com/bevry/docpad/issues/474)
- DocPad will now set permissions based on the process's ability
- Thanks to [Avi Deitcher](https://github.com/deitch), [Stephan Lough](https://github.com/stephanlough) for [issue #165](https://github.com/bevry/docpad/issues/165)
- Updated dependencies
```
1. Commit the changes with the commit title set to something like `v6.29.0. Bugfix. Improvement.` and commit description set to the changelog entry
1. Ensure the project is ready for publishing:
```
git status
git diff
npm run-script prepare
```
1. Prepare the release and publish it to npm and git:
``` bash
npm run-script release
```
> A prompt will occur asking you for a git tag annotation, enter the changelog entry that we created earlier, save and exit the prompt.
Loading

0 comments on commit cc6a806

Please sign in to comment.