Skip to content

Commit

Permalink
add open open source contributors
Browse files Browse the repository at this point in the history
  • Loading branch information
max-mapper committed Mar 13, 2014
1 parent 5d7d826 commit c95175d
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,24 @@ var game = createGame()
game.appendTo(document.body)
```

### contributing

voxel-engine is an **OPEN Open Source Project**. This means that:

> Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project.
See the [CONTRIBUTING.md](contributing.md) file for more details.

### contributors

multiplex is only possible due to the excellent work of the following contributors:

<table><tbody>
<tr><th align="left">Max Ogden</th><td><a href="https://github.com/maxogden">GitHub/maxogden</a></td><td><a href="http://twitter.com/maxogden">Twitter/@maxogden</a></td></tr>
<tr><th align="left">Kumavis</th><td><a href="https://github.com/kumavis/">GitHub/kumavis</a></td><td></td></tr>
<tr><th align="left">Deathcap</th><td><a href="https://github.com/deathcap/">GitHub/deathcap</a></td><td></td></tr>
</tbody></table>

# API

## require('voxel-engine')(options)
Expand Down
27 changes: 27 additions & 0 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# voxel-engine is an OPEN Open Source Project

-----------------------------------------

## What?

Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project.

## Rules

There are a few basic ground-rules for contributors:

1. **No `--force` pushes** or modifying the Git history in any way.
1. **Non-master branches** ought to be used for ongoing work.
1. **External API changes and significant modifications** ought to be subject to an **internal pull-request** to solicit feedback from other contributors.
1. Internal pull-requests to solicit feedback are *encouraged* for any other non-trivial contribution but left to the discretion of the contributor.
1. Contributors should attempt to adhere to the prevailing code-style.

## Releases

Declaring formal releases remains the prerogative of the project maintainer.

## Changes to this arrangement

This is an experiment and feedback is welcome! This document may also be subject to pull-requests or changes by contributors where you believe you have something valuable to add or change.

-----------------------------------------
5 changes: 5 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@
"type": "git",
"url": "[email protected]:maxogden/voxel-engine.git"
},
"contributors": [
"Max Ogden <[email protected]> (https://github.com/maxogden)",
"Kumavis <[email protected]> (https://github.com/kumavis)",
"Deathcap <[email protected]> (https://github.com/deathcap)",
],
"dependencies": {
"voxel": "0.3.1",
"voxel-mesh": "0.2.1",
Expand Down

0 comments on commit c95175d

Please sign in to comment.