Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
14 changed files
with
330 additions
and
477 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,27 @@ | ||
# February 19, 2015 | ||
# https://github.com/bevry/base | ||
sudo: false | ||
language: node_js | ||
# ensure npm is the latest version (ignore node versions that can't run it) | ||
# ensure coffee-script is installed (needed for cake commands) | ||
# ensure dev dependencies are installed (handled via npm install) | ||
# ensure test dependencies are installed (handled via cake install) | ||
install: "npm install -g npm && npm install coffee-script && npm install && ./node_modules/.bin/cake install" | ||
# ensure our application is compiled before we run our tests | ||
before_script: "./node_modules/.bin/cake compile" | ||
script: "npm test" | ||
node_js: | ||
- "0.10" | ||
- "0.12" | ||
- iojs | ||
- '0.8' | ||
- '0.10' | ||
- '0.12' | ||
- '4' | ||
- '6' | ||
- '7' | ||
matrix: | ||
fast_finish: true | ||
cache: | ||
directories: | ||
- node_modules | ||
- "$HOME/.npm" | ||
- "$HOME/.yarn-cache" | ||
install: | ||
- eval "$(curl -s https://raw.githubusercontent.com/balupton/awesome-travis/master/scripts/node-install.bash)" | ||
before_script: | ||
- eval "$(curl -s https://raw.githubusercontent.com/balupton/awesome-travis/master/scripts/node-verify.bash)" | ||
after_success: | ||
- eval "$(curl -s https://raw.githubusercontent.com/balupton/awesome-travis/master/scripts/node-publish.bash)" | ||
notifications: | ||
irc: | ||
- "irc.freenode.org#bevry-dev" | ||
slack: | ||
secure: EUOtK95dJ5lMB27BffctwnnAs81NEuloXRvJhM7QpN7SNhOK9W8Z5N/iS2OP21Wa1khc4ox38bMYDJy9F6LBLV5vrdwTUUM5R19qnGjyzl6SvFEVSqg3yzzcTrvijbwKa0GhISSzYIp7R9vylKrDmaL0eMM1dqmPgLXohT6C3E8= | ||
email: | ||
recipients: | ||
- travisci@bevry.me | ||
secure: bQ+o3UnXN1NXl+kMOwsddQNtmzf8v6Vz49HsDmFHkhh0osLAVaTGPBHkuM+H00kuyUk1OxHuj4z2CwYmY1R9S9bXLGv/k/0t5lBPhJGICafsGxRG+77DmAFSgtbX9/FL5tEyK7b2qh6T0dPaecstVnvy3sKgbut82R973zgg69M= |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,103 +1,124 @@ | ||
<!-- | ||
March 5, 2015 | ||
2017 January 27 | ||
https://github.com/bevry/base | ||
--> | ||
|
||
# Before You Post! | ||
|
||
# Contribute | ||
## Support | ||
|
||
We offer support through our [Official Support Channels](https://bevry.me/support). 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://bevry.me/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. Install [Node.js](https://learn.bevry.me/node/install) | ||
|
||
1. Fork the project and clone your fork - [guide](https://help.github.com/articles/fork-a-repo/) | ||
|
||
1. Setup the project for development | ||
|
||
1. Fork project and clone your fork | ||
``` bash | ||
npm run our:setup | ||
``` | ||
|
||
2. Install global dependencies | ||
|
||
### Developing | ||
|
||
1. Compile changes | ||
|
||
``` bash | ||
npm install -g coffee-script | ||
npm run our:compile | ||
``` | ||
|
||
3. Install local dependencies | ||
1. Run tests | ||
|
||
``` bash | ||
cake install | ||
npm test | ||
``` | ||
|
||
4. Compile project | ||
|
||
``` bash | ||
# Only once | ||
cake compile | ||
### Publishing | ||
|
||
# On every change | ||
cake watch | ||
``` | ||
Follow these steps in order to implement your changes/improvements into your desired project: | ||
|
||
5. Run tests | ||
|
||
``` bash | ||
cake test | ||
``` | ||
#### 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` | ||
|
||
## Publishing | ||
1. Ensure all tests pass: | ||
|
||
For project maintainers | ||
``` bash | ||
npm test | ||
``` | ||
|
||
1. Update meta files with latest information | ||
> If possible, add tests for your change, if you don't know how, mention this in your pull request | ||
``` bash | ||
cake prepublish | ||
``` | ||
|
||
This will compile the project, run tests, and update any meta files that need updating. | ||
1. Ensure the project is ready for publishing: | ||
|
||
``` | ||
npm run our:release:prepare | ||
``` | ||
|
||
2. Add a changelog entry to `HISTORY.md` with change information | ||
|
||
``` | ||
## 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 | ||
``` | ||
#### Pull Request | ||
|
||
3. Update `version` entry in `package.json` with a new number that follows semantic versioning | ||
To send your changes for the project owner to merge in: | ||
|
||
4. Commit changes | ||
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 | ||
|
||
``` 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. | ||
|
||
#### Publish | ||
|
||
5. Publish new version | ||
To publish your changes as the project owner: | ||
|
||
``` bash | ||
cake publish | ||
``` | ||
1. Switch to the master branch: | ||
|
||
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 | ||
``` | ||
``` 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 2013 April 1 | ||
- 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: | ||
|
||
``` | ||
npm run our:release:prepare | ||
``` | ||
|
||
1. Prepare the release and publish it to npm and git: | ||
|
||
``` bash | ||
npm run our:release | ||
``` |
Oops, something went wrong.