-
Notifications
You must be signed in to change notification settings - Fork 686
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
Myles Borins
committed
Jul 1, 2014
0 parents
commit 05c8ea9
Showing
126 changed files
with
23,056 additions
and
0 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# This is the official list of authors who have made a contribution that was | ||
# merged into the Famous framework. | ||
# | ||
# Names should be added to this file in the following format: | ||
# | ||
# Name or Organization <email address> | ||
# | ||
# The email address is not required for organizations. | ||
# | ||
# Please keep this list sorted alphabetically by first name. | ||
|
||
Adam Cmiel <[email protected]> | ||
Andrew de Andrade <[email protected]> <[email protected]> | ||
Andrew Kerr <[email protected]> | ||
Benjamin Cronin <[email protected]> | ||
Brian Maissy <[email protected]> | ||
Dave Fetterman <[email protected]> <[email protected]> | ||
David Valdman <[email protected]> <[email protected]> | ||
Eric Miller <[email protected]> | ||
Felix Tripier <[email protected]> <[email protected]> | ||
George Bonner <[email protected]> | ||
Hongxu Liu <[email protected]> <[email protected]> | ||
Mark Lu <[email protected]> <[email protected]> | ||
Mike O'Brien <[email protected]> <[email protected]> | ||
Rafael Cosman <[email protected]> <[email protected]> | ||
Reza Ali <[email protected]> <[email protected]> | ||
Ryan Martin <[email protected]> <[email protected]> <[email protected]> | ||
Tom Watson <[email protected]> <[email protected]> | ||
Tim Chin <[email protected]> <[email protected]> |
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 |
---|---|---|
@@ -0,0 +1,133 @@ | ||
## 0.2.2 | ||
|
||
**famous/core:** | ||
|
||
- FIX `Scene` now has support for `align`. | ||
- UPDATE `requestAnimationFrame` scoped to `window`. | ||
|
||
**famous/inputs:** | ||
|
||
- FIX `ScrollSync` position type set on `start` instead of `reset` on end. | ||
- FIX `FastClick` typo fix. | ||
|
||
**famous/math:** | ||
- FIX `Vector` `.put` can be called from a `Vector` instead of only a `register`. | ||
|
||
**famous/physics:** | ||
|
||
- FIX `Walls` `.forEach` bug. | ||
|
||
|
||
## 0.2.1 | ||
|
||
**famous/core:** | ||
|
||
- FEATURE `Transform` now has `.skewX` and `.skewY` methods | ||
|
||
**famous/inputs:** | ||
|
||
- ADD `DesktopEmulationMode` is a convenience utility to cancel mouse events | ||
- UPDATE `ScaleSync` now outputs `center` for the `[x,y]` point between two fingers | ||
|
||
**famous/physics:** | ||
|
||
- FIX time-stepping bug which caused jittering | ||
|
||
**famous/surfaces:** | ||
|
||
- FIX `InputSurface` `blur` event | ||
|
||
**famous/transitions:** | ||
|
||
- FIX `Transitionable` callback bug on `.reset` method | ||
- FIX `Transitionable` `.delay` bug when `_engineInstance` not defined. | ||
|
||
**famous/utilities:** | ||
|
||
- FIX `Timer` bug in `debounce` for clearing timers | ||
|
||
**famous/views:** | ||
|
||
- UPDATE `SequentialView` now has `itemSpacing` | ||
- FIX `FlexibleLayout` caching bug | ||
- FIX `Scrollview` `groupScroll` option | ||
- FIX `ContextualView` `DEFAULT_OPTIONS` inheritance | ||
|
||
|
||
## 0.2.0 | ||
|
||
**famous/core:** | ||
|
||
- FEATURE `Modifier` now takes `align` as well as `origin` for layout | ||
- FIX `Surface` `{size : [true, true]}` now works with origin and alignment | ||
- FIX Famo.us can now run before the `<body>` tag loads | ||
- FIX `Engine` `resize` event when an `input` field has focus | ||
|
||
**famous/inputs:** | ||
|
||
- ADD `Accumulator` can accumulate differentials from various syncs | ||
- UPDATE `GenericSync` now acts as a registry for various syncs | ||
- UPDATE `Scroll` `Rotate` and `Pinch` syncs now emit `center` for stable zooming | ||
- UPDATE `clientX`, `clientY`, on `Mouse` and `Touch` syncs | ||
- UPDATE `offsetX`, `offsetY` on `MouseSync` | ||
|
||
**famous/modifiers:** | ||
|
||
- UPDATE `StateModifier` takes `align` attribute | ||
|
||
**famous/transitions:** | ||
|
||
- FIX `Transitionable` can now transition arrays with non-numeric (`boolean`, `undefined`) values | ||
|
||
**famous/views:** | ||
|
||
- ADD `FlexibleLayout`, a layout for defining proportions of a sizing context for responsive and fixed layouts | ||
- ADD `ContextualView` is similar to `core/View` but passes in contextual information (`transform`, `size`, etc) for dynamic layouts. | ||
- FEATURE `GridLayout` now has a `gutterSize` attribute | ||
- FEATURE `Flipper` now has `setAngle` method | ||
|
||
|
||
## 0.1.2 | ||
|
||
- ADD `package.json` and `Gruntfile.js` to automate linting with Grunt and eslint | ||
- ADD `.travis.yml` for continuous integration with Travis-CI | ||
- Improved documentation | ||
|
||
**famous/core:** | ||
|
||
- FEATURE Automatic CSS `transform-matrix` pixel rounding | ||
- FIX `Modifier` zero sizing | ||
- FIX Firefox `z-index` bug | ||
|
||
**famous/inputs:** | ||
|
||
- UPDATE `FastClick` improvements for `click` events | ||
|
||
**famous/modifiers:** | ||
|
||
- FIX `StateModifier` opacity 0 bug | ||
|
||
**famous/physics:** | ||
|
||
- FIX `Walls` bug | ||
|
||
**famous/surfaces:** | ||
|
||
- ADD `Textarea` surface | ||
- ADD `FormContainerSurface` surface | ||
- ADD `SubmitInputSurface` surface | ||
|
||
**famous/views:** | ||
|
||
- FEATURE `Scrollview` group piping flag for automatic eventing | ||
- FIX `Scrollview` `options` passing | ||
- FIX `ScrollContainer` typo | ||
|
||
**famous/widgets:** | ||
|
||
- FIX `NavigationBar` `optionsManager` typo | ||
|
||
|
||
## 0.1.1 | ||
|
||
- Initial release |
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 |
---|---|---|
@@ -0,0 +1,146 @@ | ||
# Contributing to Famo.us | ||
|
||
Active involvement from the community is essential to help make famous the most | ||
capable and performant front-end JavaScript framework out there. You can help by | ||
reporting bugs, fixing bugs, adding features, contributing new modules and by | ||
by providing feedback. | ||
|
||
|
||
## Reporting bugs and other issues | ||
|
||
Famo.us is a framework that is always testing the limits of where browsers can go. As a result, it's likely that you may encounter bugs or other issues while developing with it. | ||
|
||
If you think you've encountered a bug, do the following: | ||
|
||
1. Make sure you are working with the latest version of the Famo.us `master` branch. | ||
2. Browse through the [issues](#issues) to check if | ||
anyone else has already reported. If someone has, feel free to add more | ||
information to that issue to help us solve it. | ||
3. If no one has yet submitted the issue you are encountering, check the | ||
[guidelines for deciding where to file your issue](#issues). Please be sure | ||
to include as much information as possible, include errors, warnings, | ||
screenshots, links to a video showing the problem or code that can reproduce | ||
the issue. | ||
|
||
|
||
## Contributing code | ||
|
||
The Famo.us framework is made possible by open source | ||
contributors like you. We're very interested in getting help from the greater | ||
community, but before you start it's important that you become acquainted with | ||
our workflow. Following these guidelines below will make collaboration much | ||
smoother and increase the chances that we will accept your pull request without | ||
hiccups. | ||
|
||
|
||
### Development Process | ||
|
||
Our development process is very similar to the approach | ||
described in the well-known article [A Successful Git Branching Model by Vincent | ||
Driessen][git-branching-model]. Here's an overview: | ||
|
||
* Our `master` branch is the branch upon which | ||
Famo.us developers should be basing their work on. The `master` branch is not guaranteed to be stable. | ||
* All commits intended for `master` should take place on your own personal | ||
fork, and be submitted via pull request when ready. | ||
* Only maintainers can accept pull requests from forks into the core Famo.us | ||
repository. | ||
* Please squash your commits into a single commit before making a pull request. | ||
|
||
### Getting started | ||
|
||
1. Make sure you have a [GitHub account](https://github.com/signup/free) | ||
2. [Fork famous][fork-famous] | ||
3. Keep your fork up to date. Famo.us is a fast moving project, and things are | ||
changing all the time. It's important that any changes you make are based on | ||
the most recent version of famous, since it's possible that something may | ||
have changed that breaks your pull request or invalidates its need. | ||
4. Make sure you have a [Contributor License Agreement][cla] on file. | ||
5. Read on ... | ||
|
||
|
||
### Contributor License Agreement | ||
|
||
Before we can accept any contributions to Famo.us, we first require that all | ||
individuals or companies agree to our Contributor License Agreement (CLA). The e-mail | ||
address used in the pull request will be used to check if a CLA has already been | ||
filed, so be sure to list all email addresses that you might use to submit your | ||
pull requests when filling it out. Our CLA can be found [here][cla]. | ||
|
||
### Testing and Linting | ||
|
||
Travis-ci is integrated into all of our submodules to automatically run tests on our codebase. All pull requests must pass our tests before they can be merged. Currently, the only test we support is a linting test. This ensures a consistently styled codebase. Before making a pull request, please run our linter locally. From the submodule directory, execute | ||
|
||
```js | ||
npm install | ||
npm test | ||
``` | ||
The created `node_modules` folder will be ignored in your push by our `.gitignore` file. | ||
|
||
|
||
### Branch grouping tokens | ||
|
||
All pull requests submitted to Famo.us should occur on a new branch. For these | ||
branches, we at famous use a short token indicating the nature of the branch in | ||
question followed by a solidus (`/`) and a kebab-cased string describing the | ||
branch. We are using the following tokens: | ||
|
||
bug // bug fixes | ||
wip // work in progress | ||
feat // feature | ||
|
||
Bug fixes follow a [slightly different format](#bug-fixes). | ||
|
||
### Bug fixes | ||
|
||
If you'd like to contribute a fix for a bug you've encountered, first read up on | ||
[how to report a bug][reporting-bugs-and-other-issues] and report it so we are | ||
aware of the issue. By filing the issue first, we may be able to provide you | ||
with some insight that guides you in the right direction. | ||
|
||
## Issues | ||
|
||
Famo.us is composed of several repositories, and it helps if bugs are filed in | ||
the issues section of the right repository. To help you check if your issue has | ||
already been filed or to help you file it in the right place in case it hasn't | ||
we've created the following guidelines: | ||
|
||
Below is a list of links to the issues page for all the famous framework | ||
repositories. | ||
|
||
* [famous][famous-issues] | ||
* [core][core-issues] | ||
* [events][events-issues] | ||
* [inputs][inputs-issues] | ||
* [math][math-issues] | ||
* [modifiers][modifiers-issues] | ||
* [physics][physics-issues] | ||
* [surfaces][surfaces-issues] | ||
* [transitions][transitions-issues] | ||
* [utilities][utilities-issues] | ||
* [views][views-issues] | ||
* [widgets][widgets-issues] | ||
|
||
|
||
[famous-issues]: https://github.com/famous/famous/issues | ||
[core-issues]: https://github.com/famous/core/issues | ||
[events-issues]: https://github.com/famous/events/issues | ||
[inputs-issues]: https://github.com/famous/inputs/issues | ||
[math-issues]: https://github.com/famous/math/issues | ||
[modifiers-issues]: https://github.com/famous/modifiers/issues | ||
[physics-issues]: https://github.com/famous/physics/issues | ||
[surfaces-issues]: https://github.com/famous/surfaces/issues | ||
[transitions-issues]: https://github.com/famous/transitions/issues | ||
[utilities-issues]: https://github.com/famous/utilities/issues | ||
[views-issues]: https://github.com/famous/views/issues | ||
[widgets-issues]: https://github.com/famous/widgets/issues | ||
|
||
[famous]: https://github.com/famous/famous | ||
[git-branching-model]: http://nvie.com/posts/a-successful-git-branching-model/ | ||
[semver]: http://semver.org/ | ||
[fork-famous]: https://github.com/Famous/famous/fork | ||
[unix-principles]: http://www.faqs.org/docs/artu/ch01s06.html | ||
[esr]: http://www.catb.org/esr/ | ||
[taoup]: http://www.catb.org/esr/writings/taoup/ | ||
[modifying-ojects-considered-bad]: http://perfectionkills.com/whats-wrong-with-extending-the-dom/ | ||
[cla]: http://famo.us/cla/individual |
Oops, something went wrong.