Organizing a ProtoSchool chapter? Wish you were? You're in the right place!
For more background on ProtoSchool or other ways to get involved, like building tutorials, check out our guide to contributing or view our launch presentation.
Whether you're an existing organizer or hope to become one, please read our Code of Conduct. All chapter organizers are expected to follow these guidelines to ensure the ProtoSchool community remains a welcoming place for all learners.
Check out our list of existing chapters to see if there's already a group near you or the new-chapter tag in our issue queue to see if someone has already asked to create one. If not, please open an issue on this repo asking to be added as a chapter organizer. This is an opportunity to introduce yourself and why you're interested in organizing. Here's an example to get you started:
Hi, I would like to start a ProtoSchool chapter for [name of geographic community]. I am [@YourTwitterName] on twitter and work at/on [project/organization]. I will be co-organizing this chapter with [names of other organizers]. I have been using [IPFS/IPLD/libPp2p/Multiformats] for X months and would like to help others learn as well.
Be sure to send us your requested chapter name, which must be short and all lower case. It should ideally be the name of the city where your events will be held. Choose san-francisco instead of bay-area, california or usa.
As a chapter organizer, you'll be responsible making all members feel welcome, which means upholding and enforcing your chapter's own Code of Conduct. You'll need to supply contact information that can be used by members to report and violations of that CoC within your chapter's repo or events.
Once you submit your request, a maintainer will respond with any questions and will then help to set up your chapter repository. Please be sure to enable two-factor authentication (2FA) for your GitHub account so that we can invite you to manage your new chapter repo!
Once you are an organizer, follow these instructions to set up the web presence for your ProtoSchool chapter:
Step 1 | You should have been added to the team called chapter-organizers and should have admin access to edit the new chapter repo, e.g. https://github.com/protoschool/san-francisco
Step 2
Update your readme to introduce your chapter and include calls to action for those discovering your chapter the first time. Be sure to note who the chapter organizers are, include a link to a website (if you have one), and note where members can find event listings. If you'll be creating a chapter website (see below), it's fine to keep the readme brief and link there for more detail.
Step 3 All chapters must have a Code of Conduct for your website and repository. The Contributor Covenant provides a nice template.
Chapters must also make it clear how the Code of Conduct applies to their live events, as part of the broader effort to make all people feel welcome. The Conference Code of Conduct provides a nice starting point, but will require some adaptation to the specifics of your events.
We'll provide a starter Code of Conduct for you that adapts and combines the two templates mentioned above, but you are welcome to make changes to your chapter Code of Conduct that are in keeping with the goals of the broader ProtoSchool Code of Conduct. In any Code of Conduct you create, be sure to include contact information and a procedure for reporting any incidents to chapter leadership.
Step 4 (Optional)
Each chapter can set up their own gh-pages branch on their org and GitHub Pages will automatically route http://proto.school/ to it.
(If you prefer to build a website on another platform or use a Meetup page as your website, that's fine, you just won't be able to host it on our domain.)
Step 5 | This step is important for discoverability!
Once your chapter is up and running, make a pull request to the ProtoSchool website (the protoschool.github.io repo)
to add your chapter to the existing chapters.json file, found at src/static/chapters.json.
When your pull request is accepted, your chapter will be automatically added to the listings at http://proto.school/#/chapters
You may take this step before or without building a chapter website, as long as you've completed the other steps described above to get your repo set up. Should you decide to build a website later, be sure to create a new PR adding your website URL to your chapter listing so that users will be directed to your website instead of your repo.
Your addition to the chapters.json file should look something like this:
,
{
"name": "ProtoSchool San Francisco",
"city": "San Francisco, CA",
"country": "US",
"region": "North America",
"organizers": ["mikeal"],
"website": "http://proto.school/san-francisco",
"twitter": "sfprotoschool",
"repo": "http://github.com/protoschool/san-francisco"
}
Notice how a comma is needed after the previous entry and before yours, but not at the end of the list.
Please be sure to format your JSON data according to the following guidelines. (Fields marked in bold are required.)
| Field | Description |
|---|---|
| name | Whatever you call your events, often "ProtoSchool " |
| city | The name of your city or town, which will appear on the Chapters page, often or <City, State> but can be any geocode-able string |
| country | Please list your country's ISO-3166 2-letter country code for consistency |
| region | Choose an existing region from the chapters page if possible. If not then pick a broad, non-country region name, usually a continent. |
| organizers | An array of GitHub usernames |
| website | URL of the main website for your chapter, if one exists besides your GitHub repo |
| repo | GitHub repo URL (if no website field exists, your chapter listing will direct to this URL) |
| other | Any other services like Twitter, Gitter, etc. that exist for the chapter (not the organizer's info) |
- Chapters get their own website at
https://proto.school/chapter-nameif they push to agh-pagesbranch. - We can easily list all of the chapters on the ProtoSchool website.
- Chapters get their own "mailing list" in the form of GitHub issues. These can be in other languages as well (e.g. Spanish for Latin American chapters), whereas the main repos are primarily in English.
- All ProtoSchool event attendees leave with a GitHub account and a community of whom they can ask questions.
- Since all chapter members are open open source style contributors, everyone is empowered to help moderate discussions and improve the chapter website.
Once your chapter is set up and listed on your website, the fun begins! Please explore RESOURCES.md to find tips on enforcing your Code of Conduct, logo files for your chapter website, ProtoSchool stickers to distribute at your events, and more.
ProtoSchool is licensed under the Apache-2.0 and MIT licenses. See LICENSE.md for further detail.