Any contributions to our workshops are very welcome, even from beginners!
Before we get started, if you ever have any questions about anything or just want to talk through something, you can reach us almost 24/7 on the
#curriculum channel in our Slack (click here for instructions on joining).
There are three ways to contribute:
If you notice any problems or have an idea for a feature, create a GitHub issue describing the improvement you want to see. Click here to create a new GitHub issue.
If you see an error in our workshops and want to do more than just create an issue, you can submit a pull request to fix the issue. A walkthrough of how to submit a pull request can be found here.
We also love contributions of new workshops! Make sure you’ve read through
CONTRIBUTING.md before you start though. We also highly recommend getting the input of the rest of the community in the Slack.
Here are our instructions for making a workshop:
Step 1: Creating the necessary files and folders:
CONTRIBUTING.mdand cloned the
workshops/directory. The name of your workshop should only be one or two words like
README.mdfile. You will be writing your workshop in this Markdown file. Feel free to create other Markdown files that you link to from your newly
README.md(see Dodge as an example of a workshop that does this.
README.md, you’ll want to create a
metadata.ymlfile inside your directory. This will contain a unique, random 8 character string, a name, and a description. Please look at Personal Website for an example.
workshops/README.md, add your workshop to the Workshops list.
Step 2: Create the workshop with the following requirements:
jsbinctl. Here is a link to
Step 3: Check that you’ve done the following:
So you’ve finished writing a great workshop, and you’re ready to make a pull request. Awesome! But before you do, make sure you’ve covered these items:
metadata.ymlfile inside your directory.
Great. Now, follow these instructions on how to submit a pull request. After you’ve done that, make sure the CircleCI tests are all passing. If there are errors, click on “View Details” and see what the errors are. Common errors include:
Intellectual property ownership of the workshop:
Under our license, your contributions will be under the Creative Commons CCBY-SALICENSE.