Skip to content

Commit

Permalink
Move and redo some of the contribution section to it's own file
Browse files Browse the repository at this point in the history
Also add logo to readme and some minor cleanup.
  • Loading branch information
sindresorhus committed Sep 17, 2012
1 parent db5519e commit 7d2fd02
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 28 deletions.
41 changes: 41 additions & 0 deletions contributing.md
@@ -0,0 +1,41 @@
# Contribute

We're happy to accept contributions in the form of new apps, bug fixes, issues, etc. If you want to help out, add a comment on the issue you want to work on and start hacking. Please open an issue for discussion before submitting framework combinations (eg. Backbone + RequireJS).


## Pull Request Guidelines

- Develop in a topic branch (not `master`) and submit against the `labs` folder in the default `gh-pages` branch
- Squash your commits
- Write a convincing description of your PR and why we should land it


## Submitting a New App

- **Read the [App Specification](wiki/App-Specification) thoroughly**
- Make sure it hasn't already been submitted or declined by searching the issue tracker
- Looking at our most recent [reference app](https://github.com/addyosmani/todomvc/tree/master/architecture-examples/backbone)
- Test in the [supported browsers](https://github.com/addyosmani/todomvc/wiki/Home/)

One of us will be happy to review your submission and discuss any changes that may be required before it can be included. Apps will typically land first in Labs, reaching the 'stable' mark once we and the community are happy with it.


## Browser Compatibility

Modern browser (latest: Chrome, Firefox, Opera, Safari, IE9)


## Unit Tests

At present, due to the large number of apps in the TodoMVC suite we haven't been mandating that unit tests be written in order for an application to be accepted.

We do however plan on addressing this in a future release as we feel it would both help further ensure consistency and provide developers with a reference for writing tests for each framework.

If you are a library author or contributor wishing to start work on writing tests for an implementation, we'll happily consider including them in the future. This may change based on how we specify unit tests must be structured and so on post 1.0.

This comment has been minimized.

Copy link
@oveddan

oveddan Dec 8, 2014

Does this mean if we submit a PR with some unit tests in them for an existing TodoMVC example, it won't be accepted until testing is standardized in 1.0?

This comment has been minimized.

Copy link
@passy

passy Dec 8, 2014

Member

You realize that this change was made over 2 years ago, right? :)

This comment has been minimized.

Copy link
@oveddan

oveddan Dec 8, 2014

Did not, thanks for point that out :) I just saw quite a few examples with no tests and was wondering why. Are there unit test guidelines anywhere? Would love to take stab at the React examples.

This comment has been minimized.

Copy link
@oveddan

oveddan Dec 15, 2014

@passy So would you accept PR's that add unit tests to some examples?


## A Final Note

Note that due to the current number of MVC/MVVM/MV* frameworks in circulation, it's not always possible to include each one in TodoMVC, but we'll definitely discuss the merits of any framework prior to making a decision :)

For applications that we feel don't quite match the goals of the project, but which we feel still offer value, we're happy to include references to them in our official [wiki](https://github.com/addyosmani/todomvc/wiki/Other-implementations).
34 changes: 6 additions & 28 deletions readme.md
Expand Up @@ -3,6 +3,9 @@
#### Helping you select an MV\* framework #### Helping you select an MV\* framework




![logo](https://raw.github.com/addyosmani/todomvc/gh-pages/site/img/logo.svg)


## Introduction ## Introduction


Developers these days are spoiled with choice when it comes to selecting an MV\* framework for structuring and organizing JavaScript web apps. Developers these days are spoiled with choice when it comes to selecting an MV\* framework for structuring and organizing JavaScript web apps.
Expand Down Expand Up @@ -76,7 +79,7 @@ Live demos are available on our [website](http://todomvc.com)


## Screenshot ## Screenshot


![screenshot](https://raw.github.com/addyosmani/todomvc/master/screenshot.png) ![screenshot](https://raw.github.com/addyosmani/todomvc/gh-pages/screenshot.png)




## Team ## Team
Expand Down Expand Up @@ -105,39 +108,14 @@ It is meant to be used as a gateway to reviewing how a basic application using a


## Project Status ## Project Status


TodoMVC 1.0 was just released and includes re-writes of almost all applications, ensuring they follow a consistent set of specifications and are using the latest versions of all libraries and frameworks in use. We've also addressed framework author concerns about routing by adding this to many of the more mainstream applications in the project. TodoMVC 1.0 includes re-writes of almost all applications, ensuring they follow a consistent set of specifications and are using the latest versions of all libraries and frameworks in use. We've also addressed framework author concerns about routing by adding this to many of the more mainstream applications in the project.




## Getting Involved ## Getting Involved


Whilst we enjoy implementing and improving existing Todo apps, we're always interested in speaking to framework authors (and users) wishing to share Todo app implementations in their framework/solution of choice. Whilst we enjoy implementing and improving existing Todo apps, we're always interested in speaking to framework authors (and users) wishing to share Todo app implementations in their framework/solution of choice.



Check out our [contribution docs](todomvc/blob/gh-pages/contributing.md) for more info.
### New Applications

If you have an implementation you would like to show us or a patch you would like to send upstream, please feel free to send through a pull request after:

* Reading our [contribution guidelines](https://github.com/addyosmani/todomvc/wiki)
* Going through our [application specification](https://github.com/addyosmani/todomvc/wiki/App-Specification)
* Looking at our most recent [reference application](https://github.com/addyosmani/todomvc/tree/master/architecture-examples/spine)

One of us will be happy to review your submission and discuss any changes that may be required before they can be included. Applications will typically land first in Labs, reaching the 'stable' mark once we have verified they meet all of the application specifications referenced above.


### Unit Tests

At present, due to the large number of applications in the TodoMVC suite we haven't been mandating that unit tests be written in order for an application to be accepted.

We do however plan on addressing this in a future release as we feel it would both help further ensure consistency and provide developers with a reference for writing tests for each framework.

If you are a library author or contributor wishing to start work on writing tests for an implementation, we'll happily consider including them in the future. This may change based on how we specify unit tests must be structured and so on post 1.0.


### A Final Note

Note that due to the current number of MVC/MVVM/MV* frameworks in circulation, it's not always possible to include each one in TodoMVC, but we'll definitely discuss the merits of any framework prior to making a decision :)

For applications that we feel don't quite match the goals of the project, but which we feel still offer value, we're happy to include references to them in our official [wiki](https://github.com/addyosmani/todomvc/wiki/Other-implementations).




## License ## License
Expand Down

0 comments on commit 7d2fd02

Please sign in to comment.