Every Global Sprint project should be ready to encourage and accept contributions from a group of diverse, skilled and passionate people from around Mozilla’s Network.
REGISTERED Project Requirements
When you fill out a project application form, you’ll receive a response with a link to a GitHub issue (which is a page that will represent your project on the Global Sprint site). This is where you’ll start documenting your project for the Sprint. The issue will contain a template for you to fill out with project information– name, description… some very simple things! To complete your registration, you will also need:
- A GitHub repository for your project. GitHub is an online, easy-to-use online platform for collaborative work and managing changes to code and content. A repository is your collection of project files (code,content) on GitHub. You DON’T need to be an expert in GitHub (or the version control software Git that powers it) to set up a repository, add project documentation, and create “issues” or chunks of work that participants can help with. If you are new to GitHub, refer to the tutorials below.
- The first part of this tutorial shows how to register for a GitHub account. The rest of the tutorial shows how participants will use GitHub to interact with you and your project!
- This tutorial explains how to create a project repository unsing our templates.
- Here is a set of complete lessons on using GitHub– these are NOT required, only useful if you plan to use GitHub to work on files with your collaborators. If you plan to use Google Docs or Etherpad, you won’t need to know this!
The README is your go-to project documentation file on your project Repository. The README explains what the project is, why the work is important, and how work currently underway supports the project goals. Your README should be written to be understandable to newcomers who might not be experts in your field or programming language, but still want to pitch in! If you’re not sure where to start with your README, refer to this lesson, part of our Open Leadership Training Series.
A license indicates to the world how exactly your project is open– how the code, content, curriculum, or design of an event can be used, distributed, reused, and remixed by others. If you need more info about choosing a license refer to this lesson.
The issue tracker is a GitHub feature that allows you to describe tasks or chunks of work known as “issues”. Others can comment on an issue to discuss the work. You can assign an issue to a contributor, add tags to add extra information or categories to the work (like “new feature”, “help wanted”, or “good first bug”) and you can link milestone info to an issue to help prioritze work. “Open” issues are work that needs to be done or is underway. “Closed” issues are work that’s completed. This tutorial explains how to use the Issues tracker on GitHub to manage contributions. Coming soon!
That’s all you need to be REGISTERED for the Sprint! Good project documentation, however, enables contributors to understand project aims and start collaborating quickly and easily right away. To become a FEATURED project highlighted on our Projects Page, complete the list of documents below. If you’re new to working open, we’ve inculded helpful info about each document and why it’s important to your project’s success at the Sprint.
FEATURED Project Requirements
These Guidelines tell potential contributors exactly HOW they can help– from the format and style for any contributions to the steps required for submission and approval. Without this document, contributors won’t know how to help out, so Contributor Guidelines are very, very important. For more info on how to write our own Guidelines check out this lesson.
Code of Conduct/Participation Guidelines
This document outlines shared values and norms that contributors agree to when they join a project community. Good Codes of Conduct (CoC) should highlight positive community behaviors like cooperation and honesty, as well as describing the negative behaviors that are not permitted, like harrassment or descrimination. A good CoC encourages contribution by letting contributors know they’ll be treated respectfully. For an example, look at Mozilla’s Participation Guidelines (and feel free to reuse and remix it for your project). If you need help writing your own CoC, refer to this lesson.
EXTRA CREDIT: Supercharge your Sprint project!
These items are above and beyond what’s required to be a FEATURED project. Do these exercises to maximize your Open Leadership skills.
- Vision Statement
By coming up with a super short, clear statement about what you’re doing and why, you can become a better communicator and increase interest and contributor involvement with your open project. This quick exercise helps you create a polished statmement.
- Open Canvas
Open Canvas is a one-page planning tool designed specifically for open projects, modeled on a business plan format used in the start-up world. Creating an Open Canvas can help you think strategically about your project. Our Open Canvas lesson is here.
- Personas Exercise
A persona is a profile of a potential contributor or user which you can use to design a welcoming and easy process for partcipation on your open project. Personas are a great tool to help you understand your community and grow it to sustain your project. Our exercise on personas is here.