-
Notifications
You must be signed in to change notification settings - Fork 44
curate
We're so excited to have your help curating great examples! Curators have the overall responsibility of creating content and culture to help our community thrive. You'll have three jobs, described below.
A major part of this role is becoming knowledgeable about how to write programs in Wordplay. This knowledge will help you create examples, answer others' questions about the language, and evaluate the content that others create for content violations. Learning a new programming language takes time, so don't worry if you don't understand it right away!
We want to create rich Wordplay examples that inspire students to create their own projects. Your goal is to create interesting examples that illustrate design patterns, functionality, and ideas not yet illustrated on the platform. This means becoming an expert on the Wordplay programming language and platform.
Creating performances entails:
- Think of something you'd like to make, alone or with others, and create a GitHub
enhancement
issue describing what you'd like to make. If you can't think of something, check for issues with the labelexample
for ideas to work on. - Request to be assigned the issue.
- Add the
needs design
label and draft your design concept for the example. - Tag a maintainer when you're ready for design review.
- Implement, document, and debug it! The best way to do this is to use wordplay.dev, as any other creator would. This is also a good way for us to regularly test the experience of using Wordplay. As you work, file any issues for defects or enhancement ideas you find. (You're in the best position to tell us what could be improved).
- When you have a prototype, make it public and post a link to it in #curate on Discord. Get feedback from the community and improve it!
- Make sure your project has a name, that each of its source files has a reasonable name, and that it has language tags in at least one one language.
- Comment functions, structures, and names using the
\
`` syntax, explaining how each line works so that newcomers can use your example to learn. - When you think it's ready for sharing, find or create a gallery in which to share it. We can create new public galleries for everyone's work.
After you're done sharing your project, your last step is to archive it in the GitHub repository. We do this primarily to gather test cases: we analyze all example projects as part of our verification step, and so if someone introduces a defect that breaks your project, this is how we'll know. To archive it:
- Complete the setup steps to configure your local environment.
- Find
static/examples
and you'll see a set of example files. Open any of them, and you'll see that the first line of the file is the project name, and the rest of the lines are source files and code. Refer to other examples in thestatic/examples
folder to see the structure of the file. Make a new file that mimics this structure and copy i - Create a branch off
main
to store your example and its edits. It should be formatted to include the issue number and a descriptive name, e.g.,234-playful-example
n our program from online. - Commit your example to your branch, and submit your branch as a pull request, proposing to merge it with main. We will review and give feedback, and we'll iterate until your branch is ready to merge. You can see instructions for pull requests in the develop guidelines.
In addition to creating content, your job is also to moderate content.
When creators create projects, they can make them public or put them in public galleries. When they do so, they promise to ensure that it follows our content moderation guidelines. (You can see our guidelines in the Rights
page, or in the sharing dialog for a project or gallery). Until a project is moderated, it will show a content warning dialog.
Moderation involves going to the moderate page, which will show unmoderated public content. Review the content and decide whether it violates any of the content moderation guidelines, then submit, and you'll see the next unmoderated project. We don't yet have any procedures for doing this work regularly, so reach out to Amy to help set some up.
To get moderator privileges, DM your Wordplay username to Amy in Discord, and she will add you.
We want Discord to be a lively and welcoming place.
- Join the Discord
- Request the
moderator
role so people know your role on the Discord. - Regularly monitor channels, checking for affirming pro-social behavior and checking for rule violations.
- Identify needs for new channels or other ways for contributors to engage.
- Report any violations to admins.
- Regularly monitor #help-and-feedback, answering questions, gathering clarifications about bugs and enhancements, and when appropriate, alerting the verification team to bugs and enhancements to report to GitHub.
- Update this list of practices to help future moderators
Do you find something confusing on this page? Submit a maintenance issue, so we can improve it.