Project Chantootle (pronounced "Chipotle") is the code name for an as-yet unnamed project. The goal of Chantootle will be to provide a place for Github users to submit ideas they have for open source projects, get feedback, and maybe even find another developer to work on the idea with them.
Chantootle itself grew out of a need for an open source project idea and not being happy with what was out there.
How to Contribute
Getting Set Up
- Install Python 2.7.X
- Install setuptools
- Install MongoDB
- Install virtualenv:
- Fork the repo
- Clone your repo to your dev system and move to the project directory
- Register an application on github, to receive OAuth credentials needed for development/testing.
cp chantootle/settings_local.template.py chantootle/settings_local.py
- Configure the
chantootle/settings_local.pyto the values you received after step 7.
- Create a Virtual Environment:
- Enter your Virtual Environment:
- Install Chantootle in "develop" mode:
python setup.py develop
- Pick an issue
- Develop that issue
- If unit tests don't exist for that issue:
- Write unit tests which test the issue
- Run all unit tests.
python setup.py test
- Commit your changes to your fork
- Open a pull request
How an idea becomes a project
- A github user is going about their daily business and has a spark, an inspiration, maybe even an arousal in their mind about something they wish existed for their (and everybody's) free use.
- They head to http://www.chantootle.com (or whatever the final domain is
called), log in with their github credentials, and create a project
suggestion of no more than 1000 characters to get the conversation started.
- Let's assume they called the project Brontupasto (pronounced "Bruschetta")
- They also pick the open source license they want the project to use/be compatible with.
- Chantootle creates a repo in the user's account named "Brontupasto"
- Other Chantootle users comment on Brontupasto.
- Other Chantootle users up vote Brontupasto.
- Some users may want to develop the idea further, so they click a "fork this"
button which forks Brontupasto into their own account, where they can work on
the idea themselves.
- The button would keep track of how many forks the project has.
- The normal github development process would follow - people submit pull requests to the main project..
- Non-monetary Profit! (open source, duh.)
How a coder gets involved
- Steve Larsoosen (pronounced "Steig Larsson") wants to do some coding this weekend, but he doesn't know what to work on.
- Steve fires up his browser and points it at http://www.chantootle.com (or whatever the final domain is called), and stares at the list of project ideas for a little while.
- He is pretty confident in his python abilities, so he decides to filter the project ideas by the "python" language tag.
- Steve loves the web, so he narrows his list further by choosing the "web" tag.
- Steve sees Brontupasto and thinks it's a great idea, so he clicks the "fork this" button to get started on his glorious weekend hackathon.
- Something for Gists (smaller projects that don't require offical projectdom, but just quick solutions)