Update repository to match other projects

Author: LPGhatguy

.editorconfig

@@ -1,6 +1,6 @@
 root = true
 
-[*]
+[*.lua]
 indent_style = tab
 end_of_line = lf
 charset = utf-8

.gitignore

@@ -1,3 +1,3 @@
 /modules
 /luacov.*
-/rodux-installer.lua
+/installer.lua

.travis.yml

@@ -15,11 +15,12 @@ before_install:
   - export PATH=$PATH:$PWD/lua_install/bin
 
 install:
+  - luarocks install luafilesystem
   - luarocks install busted
   - luarocks install luacov
   - luarocks install luacov-coveralls
   - luarocks install luacheck
-  - ./install-dependencies
+  - lua bin/install-dependencies.lua
 
 script:
   - luacheck lib

CONTRIBUTING.md

@@ -1,2 +1,72 @@
 # Contributing to Rodux
-TODO
+Thanks for considering contributing to Rodux! This guide has a few tips and guidelines to make contributing to the project as easy as possible.
+
+## Bug Reports
+Any bugs (or things that look like bugs) can be reported on the [GitHub issue tracker](https://github.com/Roblox/Rodux/issues).
+
+Make sure you check to see if someone has already reported your bug first! Don't fret about it; if we notice a duplicate we'll send you a link to the right issue!
+
+## Feature Requests
+If there are any features you think are missing from Rodux, you can post a request in the [GitHub issue tracker](https://github.com/Roblox/Rodux/issues).
+
+Just like bug reports, take a peak at the issue tracker for duplicates before opening a new feature request.
+
+## Working on Rodux
+To get started working on Rodux, you'll need:
+* Git
+* Lua 5.1
+* [LuaFileSystem](https://keplerproject.github.io/luafilesystem/) (`luarocks install luafilesystem`)
+* [Luacheck](https://github.com/mpeterv/luacheck) (`luarocks install luacheck`)
+* [LuaCov](https://keplerproject.github.io/luacov) (`luarocks install luacov`)
+
+Once you have all of these installed, you can run the `install-dependencies` script to grab a couple additional local dependencies automatically.
+
+Finally, you can run all of Rodux's tests with:
+
+```sh
+lua spec.lua
+```
+
+Or, to generate a LuaCov coverage report:
+
+```sh
+lua -lluacov spec.lua
+luacov
+```
+
+## Pull Requests
+Before starting a pull request, open an issue about the feature or bug. This helps us prevent duplicated and wasted effort. These issues are a great place to ask for help if you run into problems!
+
+Before you submit a new pull request, check:
+* Code Style: Match the existing code!
+* Changelog: Add an entry to [CHANGELOG.md](CHANGELOG.md)
+* Luacheck: Run [Luacheck](https://github.com/mpeterv/luacheck) on your code, no warnings allowed!
+* Tests: They all need to pass!
+
+### Code Style
+Try to match the existing code style! In short:
+
+* Tabs for indentation
+* Double quotes
+* One statement per line
+
+Eventually we'll have a tool to check these things automatically.
+
+### Changelog
+Adding an entry to [CHANGELOG.md](CHANGELOG.md) alongside your commit makes it easier for everyone to keep track of what's been changed.
+
+Add a line under the "Current master" heading. When we make a new release, all of those bullet points will be attached to a new version and the "Current master" section will become empty again.
+
+### Luacheck
+We use [Luacheck](https://github.com/mpeterv/luacheck) for static analysis of Lua on all of our projects.
+
+From the command line, just run `luacheck lib` to check the Rodux source.
+
+You should get it working on your system, and then get a plugin for the editor you use. There are plugins available for most popular editors!
+
+### Tests
+When submitting a bug fix, create a test that verifies the broken behavior and that the bug fix works. This helps us avoid regressions!
+
+When submitting a new feature, add tests for all functionality.
+
+We use [LuaCov](https://keplerproject.github.io/luacov) for keeping track of code coverage. We'd like it to be as close to 100% as possible, but it's not always easy.

README.md

@@ -7,7 +7,7 @@
 		<img src="https://coveralls.io/repos/github/Roblox/Rodux/badge.svg?branch=master" alt="Coveralls Coverage" />
 	</a>
 	<a href="#">
-		<img src="https://img.shields.io/badge/docs-website-brightgreen.svg" alt="Documentation" />
+		<img src="https://img.shields.io/badge/docs-soon-red.svg" alt="Documentation" />
 	</a>
 </div>
 
@@ -32,9 +32,40 @@ This installation script is generated by a tool called [rbxpacker](https://githu
 * Use a plugin like [rbxfs](https://github.com/LPGhatguy/rbxfs) to sync the files into a place
 
 ## Usage
-TODO
+Rodux works just like [Redux](https://redux.js.org)'s base API with the addition of [Redux Thunk](https://github.com/gaearon/redux-thunk) for simple side effects.
 
-## License
-Rodux is available under the Apache 2.0 license. See [LICENSE](LICENSE) for details.
+Documentation is currently in progress!
+
+```lua
+local Rodux = require(script.Parent.Rodux)
+
+local function reducer(state, action)
+	state = state or {
+		frobulations = 0,
+	}
+
+	if action.type == "frobulate" then
+		return {
+			frobulations = state.frobulations + 1,
+		}
+	end
+
+	return state
+end
+
+local store = Rodux.store.new(reducer)
 
-For easy distribution, the license is duplicated in [lib/LICENSE.lua](lib/LICENSE.lua).
+store:getState() -- { frobulations = 0 }
+
+store:dispatch({
+	type = "frobulate",
+})
+
+store:getState() -- { frobulations = 1 }
+```
+
+## Contributing
+Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for information.
+
+## License
+Rodux is available under the Apache 2.0 license. See [LICENSE](LICENSE) for details.

bin/build-installer.lua

@@ -0,0 +1,9 @@
+--[[
+	Generates an install script using rbxpacker.
+
+	It should be run from the project directory, like:
+
+		lua bin/build-installer.lua
+]]
+
+os.exit(os.execute("rbxpacker --exclude **/*.spec.lua --folder Rodux --name Rodux lib LICENSE > installer.lua"))

bin/install-dependencies.lua

@@ -0,0 +1,37 @@
+--[[
+	Dependencies added here will be installed into the `modules` folder.
+
+	It should be run from the project directory, like:
+
+		lua bin/install-dependencies.lua
+]]
+
+local dependencies = {
+	lemur = {
+		git = "https://github.com/LPGhatguy/lemur.git",
+		version = "v0.1.0",
+	},
+	testez = {
+		git = "https://github.com/Roblox/TestEZ.git",
+		version = "master",
+	},
+}
+
+local lfs = require("lfs")
+
+lfs.mkdir("modules")
+assert(lfs.chdir("modules"))
+
+for name, dependency in pairs(dependencies) do
+	os.execute(("git clone --depth=1 %s %s"):format(
+		dependency.git,
+		name
+	))
+
+	assert(lfs.chdir(name))
+	os.execute(("git checkout %s"):format(
+		dependency.version
+	))
+
+	assert(lfs.chdir(".."))
+end

build-installer

@@ -1,33 +1,69 @@
+--[[
+	Loads our library and all of its dependencies, then runs tests using TestEZ.
+]]
+
+-- If you add any dependencies, add them to this table so they'll be loaded!
+local LOAD_MODULES = {
+	{"lib", "Library"},
+	{"modules/testez/lib", "TestEZ"},
+}
+
+-- This makes sure we can load Lemur and other libraries that depend on init.lua
+package.path = package.path .. ";?/init.lua"
+
+-- If this fails, make sure you've run `lua bin/install-dependencies.lua` first!
 local lemur = require("modules.lemur")
 
-local habitat = lemur.Habitat.new()
+--[[
+	Collapses ModuleScripts named 'init' into their parent folders.
+
+	This is the same behavior as the collapsing mechanism from rbxpacker.
+]]
+local function collapse(root)
+	local init = root:FindFirstChild("init")
+	if init then
+		init.Name = root.Name
+		init.Parent = root.Parent
 
-local Rodux = lemur.Instance.new("Folder")
-Rodux.Name = "Rodux"
-habitat:loadFromFs("lib", Rodux)
+		for _, child in ipairs(root:GetChildren()) do
+			child.Parent = init
+		end
 
--- Simulate rbxpacker's 'collapse' mechanism
-do
-	local newRoot = Rodux:FindFirstChild("init")
-	newRoot.Name = Rodux.Name
-	newRoot.Parent = nil
+		root:Destroy()
+		root = init
+	end
 
-	for _, child in ipairs(Rodux:GetChildren()) do
-		child.Parent = newRoot
+	for _, child in ipairs(root:GetChildren()) do
+		if child:IsA("Folder") then
+			collapse(child)
+		end
 	end
 
-	Rodux = newRoot
+	return root
+end
+
+-- Create a virtual Roblox tree
+local habitat = lemur.Habitat.new()
+
+-- We'll put all of our library code and dependencies here
+local Root = lemur.Instance.new("Folder")
+Root.Name = "Root"
+
+-- Load all of the modules specified above
+for _, module in ipairs(LOAD_MODULES) do
+	local container = lemur.Instance.new("Folder", Root)
+	container.Name = module[2]
+	habitat:loadFromFs(module[1], container)
 end
 
-local TestEZ = lemur.Instance.new("Folder")
-TestEZ.Name = "TestEZ"
-habitat:loadFromFs("modules/testez/lib", TestEZ)
+collapse(Root)
 
-local TestBootstrap = habitat:require(TestEZ.TestBootstrap)
-local TextReporter = habitat:require(TestEZ.Reporters.TextReporter)
+-- Load TestEZ and run our tests
+local TestEZ = habitat:require(Root.TestEZ)
 
-local results = TestBootstrap:run(Rodux, TextReporter)
+local results = TestEZ.TestBootstrap:run(Root.Library, TestEZ.Reporters.TextReporter)
 
+-- Did something go wrong?
 if results.failureCount > 0 then
 	os.exit(1)
 end