diff --git a/.jscs.json b/.jscs.json index 2ca2f74..a03292c 100644 --- a/.jscs.json +++ b/.jscs.json @@ -49,41 +49,6 @@ , "<" , "<=" ] - , "disallowLeftStickedOperators": [ - "?" - , "+" - , "-" - , "/" - , "*" - , "=" - , "==" - , "===" - , "!=" - , "!==" - , ">" - , ">=" - , "<" - , "<=" - ] - , "requireRightStickedOperators": [ - "!" - ] - , "disallowRightStickedOperators": [ - "?" - , "+" - , "/" - , "*" - , ":" - , "=" - , "==" - , "===" - , "!=" - , "!==" - , ">" - , ">=" - , "<" - , "<=" - ] , "disallowSpaceAfterPrefixUnaryOperators": [ "++" , "--" diff --git a/CHANGELOG.md b/CHANGELOG.md index 0be5520..4348399 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,19 +1,17 @@ -# Changelog - -## 0.1.3 - 2014-09-16 +# 0.1.3 - 2014-09-16 - clicking on the current url somewhere does not produce a full reload by default (see option `currentUrlFullReload`) - fix `document.implementation.createHTMLDocument` error (in IE10, ref [#16](https://github.com/MoOx/pjax/pull/16)) -## 0.1.2 - 2014-04-03 +# 0.1.2 - 2014-04-03 - pjax.js relocated in `src/` - attributes of pjaxified document are now available -## 0.1.1 - 2014-04-02 +# 0.1.1 - 2014-04-02 - Safer UMD wrapper (fix concat issue) -## 0.1.0 - 2014-03-24 +# 0.1.0 - 2014-03-24 Initial release diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index bde99ff..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,185 +0,0 @@ -# Contributing Guide - -Please take a moment to review this document in order to make the contribution -process easy and effective for everyone involved. - -Following these guidelines helps to communicate that you respect the time of -the developers managing and developing this open source project. In return, -they should reciprocate that respect in addressing your issue, assessing -changes, and helping you finalize your pull requests. - - -## Using the issue tracker - -The issue tracker is the preferred channel for [bug reports](#bugs), -[features requests](#features) and [submitting pull -requests](#pull-requests). - - - -## Bug reports - -A bug is a _demonstrable problem_ that is caused by the code in the repository. -Good bug reports are extremely helpful - thank you! - -Guidelines for bug reports: - -1. **Use the GitHub issue search** — check if the issue has already been - reported. - -2. **Check if the issue has been fixed** — try to reproduce it using the - latest `master` or development branch in the repository. - -3. **Isolate the problem** — ideally create a [reduced test - case](http://css-tricks.com/6263-reduced-test-cases/). - -A good bug report shouldn't leave others needing to chase you up for more -information. Please try to be as detailed as possible in your report. What is -your environment? What steps will reproduce the issue? What OS experiences the -problem? What would you expect to be the outcome? All these details will help -people to fix any potential bugs. - -Example: - -> Short and descriptive example bug report title -> -> A summary of the issue and the browser/OS environment in which it occurs. If -> suitable, include the steps required to reproduce the bug. -> -> 1. This is the first step -> 2. This is the second step -> 3. Further steps, etc. -> -> `` - a link to the reduced test case -> -> Any other information you want to share that is relevant to the issue being -> reported. This might include the lines of code that you have identified as -> causing the bug, and potential solutions (and your opinions on their -> merits). - - - -## Feature requests - -Feature requests are welcome. But take a moment to find out whether your idea -fits with the scope and aims of the project. It's up to *you* to make a strong -case to convince the project's developers of the merits of this feature. Please -provide as much detail and context as possible. - - - -## Pull requests - -Good pull requests - patches, improvements, new features - are a fantastic -help. They should remain focused in scope and avoid containing unrelated -commits. - -**Please ask first** before embarking on any significant pull request (e.g. -implementing features, refactoring code), otherwise you risk spending a lot of -time working on something that the project's developers might not want to merge -into the project. - -Please adhere to the coding conventions used throughout a project (indentation, -accurate comments, etc.) and any other requirements (such as test coverage). - -Adhering to the following this process is the best way to get your work -included in the project: - -1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork, - and configure the remotes: - - ```bash - # Clone your fork of the repo into the current directory - git clone https://github.com//happyplan - # Navigate to the newly cloned directory - cd happyplan - # Assign the original repo to a remote called "upstream" - git remote add upstream https://github.com/happyplan/happyplan - ``` - -2. If you cloned a while ago, get the latest changes from upstream: - - ```bash - git checkout master - git pull upstream master - ``` - -3. Create a new topic branch (off the main project development branch) to - contain your feature, change, or fix: - - ```bash - git checkout -b - ``` - -4. Make sure to update, or add to the tests when appropriate. Patches and - features will not be accepted without tests. Run `npm test` to check that - all tests pass after you've made changes. - -5. Commit your changes in logical chunks. Please adhere to these [git commit - message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) - or your code is unlikely be merged into the main project. Use Git's - [interactive rebase](https://help.github.com/articles/interactive-rebase) - feature to tidy up your commits before making them public. - -6. Locally merge (or rebase) the upstream development branch into your topic branch: - - ```bash - git pull [--rebase] upstream master - ``` - -7. Push your topic branch up to your fork: - - ```bash - git push origin - ``` - -8. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) - with a clear title and description. - -9. If you are asked to amend your changes before they can be merged in, please - use `git commit --amend` (or rebasing for multi-commit Pull Requests) and - force push to your remote feature branch. You may also be asked to squash - commits. - -**IMPORTANT**: By submitting a patch, you agree to license your work under the -same license as that used by the project. - - - -## Maintainers - -If you have commit access, please follow this process for merging patches and cutting new releases. - -### Reviewing changes - -1. Check that a change is within the scope and philosophy of the project. -2. Check that a change has any necessary tests and a proper, descriptive commit message. -3. Checkout the change and test it locally. -4. If the change is good, and authored by someone who cannot commit to - `master`, please try to avoid using GitHub's merge button. Apply the change - to `master` locally (feel free to amend any minor problems in the author's - original commit if necessary). -5. If the change is good, and authored by another maintainer/collaborator, give - them a "Ship it!" comment and let them handle the merge. - -### Submitting changes - -1. All non-trivial changes should be put up for review using GitHub Pull - Requests. -2. Your change should not be merged into `master` (or another feature branch), - without at least one "Ship it!" comment from another maintainer/collaborator - on the project. "Looks good to me" is not the same as "Ship it!". -3. Try to avoid using GitHub's merge button. Locally rebase your change onto - `master` and then push to GitHub. -4. Once a feature branch has been merged into its target branch, please delete - the feature branch from the remote repository. - -### Releasing a new version - -1. Include all new functional changes in the CHANGELOG. -2. Use a dedicated commit to increment the version. The version needs to be - added to the `CHANGELOG.md` (inc. date) and the `package.json`. -3. The commit message must be of `v0.0.0` format. -4. Create an annotated tag for the version: `git tag -m "v0.0.0" v0.0.0`. -5. Push the changes and tags to GitHub: `git push --tags origin master`. -6. Publish the new version to npm: `npm publish`. diff --git a/LICENSE-MIT b/LICENSE similarity index 96% rename from LICENSE-MIT rename to LICENSE index 9abe4f5..8b39b8f 100644 --- a/LICENSE-MIT +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2014 "MoOx" Maxime Thirouin +Copyright (c) 2014 Maxime Thirouin 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 diff --git a/README.md b/README.md index 32fb5b2..3d8cdd6 100644 --- a/README.md +++ b/README.md @@ -543,23 +543,15 @@ wrapper on each page (to avoid differences of DOM between pages) --- -## [Changelog](CHANGELOG.md) - ## Contributing -Please read the file nobody reads (make me lie) [CONTRIBUTING.md](CONTRIBUTING.md) +Work on a branch, install dev-dependencies, respect coding style & run tests before submitting a bug fix or a feature. -### tl;dr; + $ git clone https://github.com/MoOx/pjax.git + $ git checkout -b patch-1 + $ npm install + $ npm test -Fork, clone, then +## [Changelog](CHANGELOG.md) -```shell -$ npm i -g gulp -$ npm i -$ gulp -``` - -Now you can work on the file, then make a commit and a push something when gulp doesn't show any error. -Thanks. - -## [License](LICENSE-MIT) +## [License](LICENSE) diff --git a/bower.json b/bower.json index 35fa215..d0ed521 100644 --- a/bower.json +++ b/bower.json @@ -2,16 +2,6 @@ "name": "pjax", "version": "0.1.3", "description": "Easily enable fast Ajax navigation on any website (using pushState + xhr)", - "main": "src/pjax.js", - "homepage": "https://github.com/MoOx/pjax", - "authors": [ - "Maxime Thirouin " - ], - "moduleType": [ - "amd", - "globals", - "node" - ], "keywords": [ "pjax", "push", @@ -21,11 +11,20 @@ "transition", "animation" ], + "main": "src/pjax.js", + "homepage": "https://github.com/MoOx/pjax", + "authors": [ + "Maxime Thirouin" + ], "license": "MIT", + "moduleType": [ + "amd", + "globals", + "node" + ], "ignore": [ "**/.*", "node_modules", - "bower_components", "test", "tests" ] diff --git a/gulpfile.js b/gulpfile.js deleted file mode 100644 index 196b0ea..0000000 --- a/gulpfile.js +++ /dev/null @@ -1,56 +0,0 @@ -var pkg = require("./package.json") - , gulp = require("gulp") - , plumber = require("gulp-plumber") - -/// -// JS Lint -/// -var jshint = require("gulp-jshint") - , jsonFiles = [".jshintrc", "*.json"] - , jsFiles = ["*.js", "src/**/*.js"] -gulp.task("scripts.lint", function() { - gulp.src([].concat(jsonFiles).concat(jsFiles)) - .pipe(plumber()) - .pipe(jshint(".jshintrc")) - .pipe(jshint.reporter("jshint-stylish")) -}) - -/// -// JS Code Sniffing -/// -var jscs = require("gulp-jscs") -gulp.task("scripts.cs", function() { - gulp.src(jsFiles) - .pipe(plumber()) - .pipe(jscs()) -}) - -// JS Alias -gulp.task("scripts", ["scripts.lint", "scripts.cs"]) - -/// -// Watch -/// -gulp.task("watch", function() { - gulp.watch(jsFiles, ["scripts"]) -}) - -/// -// Publish gh-branch -/// -var buildBranch = require("buildbranch") -gulp.task("publish", ["test"], function(cb) { - buildBranch({folder: "src"} - , function(err) { - if (err) { - throw err - } - console.log(pkg.name + " published.") - cb() - }) -}) - -// Aliases -gulp.task("build", ["scripts"]) -gulp.task("test", ["build"]) -gulp.task("default", ["test", "watch"]) diff --git a/package.json b/package.json index 2a77d59..19568d8 100644 --- a/package.json +++ b/package.json @@ -2,14 +2,6 @@ "name": "pjax", "version": "0.1.3", "description": "Easily enable fast Ajax navigation on any website (using pushState + xhr)", - "main": "src/pjax.js", - "scripts": { - "test": "echo \"Error: no test specified\" && exit 1" - }, - "repository": { - "type": "git", - "url": "https://github.com/MoOx/pjax.git" - }, "keywords": [ "pjax", "push", @@ -19,18 +11,29 @@ "transition", "animation" ], - "author": "MoOx ", - "license": "MIT", + "repository": { + "type": "git", + "url": "https://github.com/MoOx/pjax.git" + }, + "homepage": "https://github.com/MoOx/pjax", "bugs": { "url": "https://github.com/MoOx/pjax/issues" }, - "homepage": "https://github.com/MoOx/pjax", + "author": "Maxime Thirouin", + "license": "MIT", + "main": "src/pjax.js", + "files": [ + "CHANGELOG.md", + "LICENSE", + "src" + ], "devDependencies": { - "jshint-stylish": "^0.1.5", - "gulp-jscs": "^0.3.2", - "gulp-plumber": "^0.5.6", - "gulp": "^3.5.6", - "gulp-jshint": "^1.5.1", - "buildbranch": "0.0.1" + "jscs": "^1.6.2", + "jshint": "^2.5.6", + "postcss": "^2.2.5" + }, + "scripts": { + "lint": "jscs **/*.js && jshint . --exclude-path .gitignore", + "test": "npm run lint" } }