Hey, you're official! You're now part of the growing civic hacking community in South Florida. Here's a few things to get started (a couple you've probably already done).
- Create this idea issue
- Flesh out the who, where, and what questions above
- Join our Slack Group and start the conversation!
Let's get this project started! When this idea starts taking off, the Projects Core Team will start helping this project's lead(s) out with project management and connecting you to resources you may need. To get there, please complete and check off the following:
- Take 30 minutes to complete Open Leadership 101
- Create a GitHub repository. Ask for help setting up permissions if you want your repository to be within the Code For Miami Github Organization.
- Create a README file in your project repository. This file should help newcomers understand what your project is, why it's important, and kinds of help you're looking for.
- Create issues to describe each task that you plan to do or need help with and how a contributor can get started on that task. You might start and stop a lot, so consider issues as your to-do list.
- Create a team for your core contributors
- This will make it easier for you to manage your github repo access. People on a team have the same level of access. Admin access will allow your trusted contributors to make changes as needed.
- You can remove and add people to your team as needed.
- Note: You can also allow collaborators outside of your team and give them more limited access.
- Create a user group in Slack so you can "@" your core contributors all at once, without bothering other people who use the Slack channel. You'll need permission from a Slack admin, so just mention @leadership on Slack to get this set up.
- Create a Google Drive, Dropbox, or other cloud storage to share larger files. Github and Data.World are good for code and data, respectively, especially when you need version control. But they're not good for very large files, documentation, articles, etc. A cloud storage option will allow you to easily share, create, and collaborate on documents with your team and help organize ideas and thoughts.
- Doing this early on can help your team stay organized and to onboard new contributors who wouldn't have access to files you all have shared over email.
To have your project FEATURED on codefor.miami, complete the following documentation. In past projects, well-documented featured projects have more contributions than other projects.
- Create file: LICENSE to give your project an open license, allowing for sharing and remixing.
- Create file: CONTRIBUTING.md so others know how they can contribute. -- [ ] In your README, link to the Code For Miami Code of Conduct or write your own code of conduct.
- Create an easily shareable project management artifact, like an Open Canvas
- Tell Code For Miami. If your idea is in a shareable format and can benefit people around the city, go to that site and follow the instructions on the bottom of the page to showcase your work there.
IF YOU GET STUCK AT ANY POINT, FEEL FREE TO REACH OUT TO THE LEADERSHIP TEAM ON SLACK BY ADDING @LEADERSHIP TO YOUR MESSAGE. WE'RE HERE TO HELP YOU MAKE REAL CHANGES TO OUR CITY.