From 2b3e830ec69977b070bff6f2f34d4f397469e834 Mon Sep 17 00:00:00 2001 From: Fagner Brack Date: Sat, 20 Feb 2016 11:01:46 +1100 Subject: [PATCH] Create initial version of the CONTRIBUTING.md file --- CONTRIBUTING.md | 20 ++++++++++++++++++++ README.md | 15 +++++---------- 2 files changed, 25 insertions(+), 10 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..1421f5d5f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,20 @@ +Issues +------ + +If you've found a bug or have a great idea for a new feature that will help **all users** of impress.js, let us know by [adding your suggestion] +(https://github.com/bartaz/impress.js/issues/new) to the [issue tracker](https://github.com/bartaz/impress.js/issues). + +Guidelines: + +* If reporting a bug, please provide a [simplified example](https://sscce.org/) on [Pastebin](https://pastebin.com/) or [JsFiddle](https://jsfiddle.net/). + +Pull Requests +------------- + +If you have fixed a bug or implemented a feature that you'd like to share, send your [Pull Request](https://help.github.com/articles/using-pull-requests/) against the [master branch] +(https://github.com/bartaz/impress.js/tree/master). But remember that the team will only accept code that fits the purpose of impress.js + +Guidelines: + +* Create a new [topic branch](https://github.com/dchelimsky/rspec/wiki/Topic-Branches) for every separate change you make. +* Make sure impress.js runs successfully on as many browsers as you can test. diff --git a/README.md b/README.md index 90cf8cbb0..d839288f3 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ impress.js ============ -It's a presentation framework based on the power of CSS3 transforms and +It's a presentation framework based on the power of CSS3 transforms and transitions in modern browsers and inspired by the idea behind prezi.com. **WARNING** @@ -14,7 +14,7 @@ HOW TO USE IT [Use the source](http://github.com/bartaz/impress.js/blob/master/index.html), Luke ;) -If you have no idea what I mean by that, or you just clicked that link above and got +If you have no idea what I mean by that, or you just clicked that link above and got very confused by all these strange characters that got displayed on your screen, it's a sign, that impress.js is not for you. @@ -49,12 +49,7 @@ There is also a book available about [Building impressive presentations with imp WANT TO CONTRIBUTE? --------------------- -If you've found a bug or have a great idea for new feature let me know by [adding your suggestion] -(http://github.com/bartaz/impress.js/issues/new) to [issues list](https://github.com/bartaz/impress.js/issues). - -If you have fixed a bug or implemented a feature that you'd like to share, send your pull request against [dev branch] -(http://github.com/bartaz/impress.js/tree/dev). But remember that I only accept code that fits my vision of impress.js -and my coding standards - so make sure you are open for discussion :) +Please, read the [contributing guidelines](CONTRIBUTING.md) on how to create [Issues](CONTRIBUTING.md#issues) and [Pull Requests](CONTRIBUTING.md#pull-requests). **Note:** The team has changed, so there will be many changes in the upcoming versions. If you need informations about versions, check the [changelog](CHANGELOG.md). @@ -80,7 +75,7 @@ It doesn't work in Opera, as it doesn't support CSS 3D transforms. If you find impress.js working on other browsers, feel free to tell us and we'll update this documentation. As a presentation tool it was not developed with mobile browsers in mind, but some tablets are good -enough to run it, so it should work quite well on iPad (iOS 5, or iOS 4 with HTML5 polyfills) and +enough to run it, so it should work quite well on iPad (iOS 5, or iOS 4 with HTML5 polyfills) and Blackberry Playbook. Inform us of any bug and we will try to fix this. ### Still interested? Read more... @@ -108,7 +103,7 @@ transforms support. Transitions between presentation steps are based on CSS tran So these two features are required by impress.js to display presentation correctly. Unfortunately the support for CSS 3D transforms and transitions is not enough for animations to -run smoothly. If the browser doesn't support hardware acceleration or the graphic card is not +run smoothly. If the browser doesn't support hardware acceleration or the graphic card is not good enough the transitions will be laggy. Additionally the code of impress.js relies on APIs proposed in HTML5 specification, including