Skip to content

Commit

Permalink
Revamp README and stuff for Mozilla Open Leadership
Browse files Browse the repository at this point in the history
  • Loading branch information
mateoclarke committed Mar 13, 2017
1 parent 9713406 commit 8917c0c
Show file tree
Hide file tree
Showing 4 changed files with 186 additions and 17 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.DS_Store
89 changes: 72 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,39 +2,95 @@

<img src="http://dsh.re/af3f9" width="300"/>

## Problem Statement:
### Table of Contents

**How might we get broad citizen input on the city budgeting process and move the City towards the model of [participatory budgeting (PB)](http://www.participatorybudgeting.org/about-participatory-budgeting/what-is-pb/)?**
- [Project Description](#project-description)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [Design](#design)
- [Development](#development)

[Original Project Proposal](https://github.com/open-austin/project-ideas/issues/70)
## Hello!

## What are we working on now?:
We're Team Budget Party! Our team includes developers, designers, a publisher, a curriculum writer and educators from [Open Austin](https://www.open-austin.org/), the [Austin Monitor](https://www.austinmonitor.com/), and Austin ISD.

We're currently working to modify and extend the orignial budget party app to develop a Digital Mock City Council experience. Read more about our Partnership with Austin Monitor and the Mozilla Gigabit Community Fund grant we were awarded. (https://www.open-austin.org/blog/2017/02/08/budget-party-mozilla-gigabit-grant-announcement)
February 12, 2017
We are interested in the health of our civic fabric and we are excited about the potential for youth inclusion in the decision making process of local government.

We will want to interate on our progres and include more features. Check out the [Issues](https://github.com/open-austin/budgetparty/issues) to see what we're thinking about next and feel free to jump in with your own suggestions or contributions.
Thanks for coming here to learn more!

## Contributors
### Our Team

This project has recieved contributions from some wonderful volunteers.
- Graphic & UX Design:
- [Vickie O'Dell](https://github.com/VictoriaODell)
- [Miles Gilbert](https://github.com/brainnews)
- Web Development:
- [Mateo Clarke](https://github.com/mateoclarke)
- Classroom Implementation
- Michael Kanin
- Sasha Cesare
- More volunteers...

### Current Project Leads | Contact for any questions
- [@mateoclarke](https://github.com/mateoclarke) - Javascript, Web Development, Project Leader
- [@VictoriaODell](https://github.com/VictoriaODell) - UX Design
- [@brainnews](https://github.com/brainnews) - Visual Design
## Project Description

Austin Budget Party has been [awarded a Mozilla Gigabit Community Fund grant](https://learning.mozilla.org/blog/mozilla-awards-241000-to-explore-the-intersection-of-gigabit-technology-and-civics-robotics-farming-and-more) to help design and develop a **Digital Mock City Council** experience with [austinbudget.party](https://austinbudget.party/).

The goal of the grant is to create an online, open-source, digital budget debate platform and curriculum designed for middle and high school students to explore civic challenges and priorities.

Open Austin contributors partnered with the [Capital of Texas Media Foundation](https://www.cotmf.org/), publisher of the [Austin Monitor](http://www.austinmonitor.com/), to improve the budget app, develop a teaching curriculum, and implement the program in 10 pilots schools in Austin.

You can read more on our [blog post](https://www.open-austin.org/blog/2017/02/08/budget-party-mozilla-gigabit-grant-announcement) announcing the grant and from the [original project proposal](https://github.com/open-austin/project-ideas/issues/70).

## Roadmap

At this stage, we have:

1. A working prototype (version 0.0) [austinbudget.party](http://austinbudget.party/).
2. Designs for version 1.0 of Budget Party. See examples [here](https://github.com/open-austin/budgetparty/issues/74#issuecomment-284244078) and [here](https://github.com/open-austin/budgetparty/issues/73#issuecomment-284243962).
3. Tested the prototype at a Budget Game Nights and in a high school classroom.

**For the 1.0 release, we are working on:**

- A curriculum to provide context for middle school and high school students for understanding how the City Council makes decisions.
- [Information Architecture](https://github.com/open-austin/budgetparty/issues/79) and improved user workflows.
- [District Profiles](https://github.com/open-austin/budgetparty/issues/80) for users to learn about City Council demographics.
- Page Redesigns.
- [Login](https://github.com/open-austin/budgetparty/issues/72) & [save session data](https://github.com/open-austin/budgetparty/issues/75).
- New icons and [imagery](https://github.com/open-austin/budgetparty/issues/71).
- Other [technical](https://github.com/open-austin/budgetparty/issues/43) improvements.

Our target launch for v1.0 is April 7, 2017.

We will present the game and curriculum to AISD high school departments chairs on April 11, 2017.

Teachers will implement the instructional tools in May 2017.

v1.1 will follow with feedback from user testing and teachers.

## Slack

[Invite yourself](https://slack.open-austin.org/) to the Open Austin Slack Channel and join the [#budgetparty channel](https://open-austin.slack.com/messages/budgetparty).

## Contributing

This project has received contributions from some wonderful volunteers. We would love to add your name to the list below. Over the course of this project, we have opportunities to help with design, development, QA & testing, writing, and more. To contribute, you can:

- Report a bug or request a feature by opening a new issue.
- Review open issues and leave a comment if you'd like to help or if you need more information.

For more information, check out [CONTRIBUTING.md](/CONTRIBUTING.md)

### Previous Contributors
- [@graceatkins](https://github.com/graceatkins) - Policy Domain Expert, Writing
- [@graceatkins](https://github.com/graceatkins) - Policy Domain Expert, Research & Writing
- [@wilsaj](https://github.com/wilsaj) - Javascript, Web Development
- [@kmclaugh](https://github.com/kmclaugh) - Javascript, Web Development

## Design
### Design

Here is a link to our [design assets and documentation](./design). Here are [open issues labeled "Design"](https://github.com/open-austin/hack-the-budget/issues?q=is%3Aissue+is%3Aopen+label%3Adesign) where you can discuss, provide feedback or volunteer to help.

## Development
### Development

The Budget Party app is primarily written in javascript and leans heavily into the libraries [React](https://facebook.github.io/react/) and [Redux](http://redux.js.org/). The static assets are hosted via [Github pages](https://pages.github.com/). Data submitted to the server lives in a [Firebase](https://www.firebase.com/), a cloud service bought by Google.

**Getting started**

Expand All @@ -57,4 +113,3 @@ Once you have cloned this repo to you local machine, open the `app` directory in


___

74 changes: 74 additions & 0 deletions app/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at info {at} open-austin {dot} org. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
39 changes: 39 additions & 0 deletions app/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Contributing to Budget Party

:+1: :tada: First off, thanks for taking the time to contribute! :tada: :+1:

This project has received contributions from some wonderful volunteers. Our goal is to make it easy for you to jump in and help.

## What should I know before I get started?

### Code of Conduct
This project adheres to the Contributor Covenant [code of conduct](CONTRIBUTING.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to info {at} open-austin {dot} org.

### README
Our [README](README.md) is the first place you should go, if you haven't already. If you have questions about the goals or purpose of the project, we'd be happy to clarify. [Create an issue](https://github.com/open-austin/budgetparty/issues/new) and mark it with the "question" label.

### Roadmap
Our [roadmap](README.md/#roadmap) is written to give you an idea of the current status of the project. Check it out to see what we are planning to include in the next release and if there are any target dates for upcoming releases.

### Communication
We communicate in a couple different ways:
1. Github - You can [open an issue](https://github.com/open-austin/budgetparty/issues/new) to start a discussion here within Github. The project leads will get an email with your message and we will do our best to respond promptly.
2. Slack - [Invite yourself](https://slack.open-austin.org/) to the Open Austin Slack Channel and join the [#budgetparty channel](https://open-austin.slack.com/messages/budgetparty).
3. IRL - Come to an Open Austin Civic Hack Night and let's chat in person.

## How can I help?

Over the course of this project, we will have (or have had) opportunities to help with design, development, QA & testing, writing, and more. To contribute, you can:

- Report a bug or request a feature by opening a new issue.
- Review [open issues](https://github.com/open-austin/budgetparty/issues) and leave a comment if you'd like to help or if you need more information.

### Design

Here is a link to our [design assets and documentation](./design). Here are [open issues labeled "Design"](https://github.com/open-austin/hack-the-budget/issues?q=is%3Aissue+is%3Aopen+label%3Adesign) where you can discuss, provide feedback or volunteer to help.

### Development

[Issues marked with the code label](stin/budgetparty/issues?q=is%3Aissue+is%3Aopen+label%3Acode) are bugs or features that require some knowledge of CSS, React, Javascript, or Firebase.

Issues with the help wanted label indicate where the best place to start are, but contributions are welcome on any open issue. Please leave a comment before you start working in case work is underway from another contributor.

0 comments on commit 8917c0c

Please sign in to comment.