sourcecred / playground

A learning repository for contributors that are new to GitHub (under development)

Packages in this repository

This repository is a monorepo, meaning it is set up to contain multiple distinct packages, although for now it only contains one.

Package Name	Description	Subdirectory with README
sourcecred	A monolith package containing the CLI that supports instances, our JS library, and all of our supported platform plugins.	link

playground's Issues

Automated testing needs

• complete rendering of interface
• checking of front end matter for posts
• checking organization / naming of posts
• building test container to use locally (if desired, likely not required for a new user to render anything locally)

...will be adding more as I think of them (so I don't forget)

Improve learning links

Each item in the gallery (the funny memes!) serves an associated link and title that describes the gist of the image / link. For example, a joke about testing might have title "Testing in software development" and link to a site about testing. These images / links are a simple / intentional way to encourage folks to do some random learning! I chose the titles and links pretty quickly, and frankly they aren't very good. It would be great for others to critique (open a PR or discuss here) better titles / links. The file to change would be https://github.com/sourcecred/playground/blob/master/_data/gallery.yml

Discussion on Structure

I want to open up discussion for how we might go about creating this "new contributor playground" - currently the GitHub guide in the docs repository references editing an AUTHORS.md file therein, and it was suggested to instead have a separate "playground" repository to serve this purpose. My 0.02 is that it should be a small, fun repository that renders some simple web interface, and then contributing will come down to the contributor adding an image (cat / dog / animal / food / xkcd cartoon or other / favorite of some item / avatar / something else?) to some folder, and adding their name to a contributors/authors file. It will then render said fun content at https://sourcecred.github.io/playground on GitHub pages. If we come up with a cool idea I'm happy to implement. Let the discussion begin!

Prettify logos, colors and style and other assets

The current playground is fairly sparse, and I consider it a template skeleton that can be greatly improved! For example, the only place that I used a small logo is on the about page. It would be lovely to have some folks that actually have design / graphic design skills to improve upon the site design, colors (branding), and general assets.

Gallery tags

Currently, the gallery data file contains memes exclusively. I'd like to add a list of tags to this data file, and then having the gallery main page able to filter images by the tag.

Add additional challenges

The challenges page has a rather small set of basic challenges. It would be fantastic for others who have some creative juices to contribute new challenge ideas, and in doing so, to review how easy/hard it is to follow instructions for adding a challenge.

Add levels for different challenges

The challenges will be a Jekyll collection, and each challenge should be associated with a level:

• introductory
• intermediate
• advanced

The prefix of the markdown file under _challenges (or perhaps just the path in a subfolder) will be associated with the level, this way, we can just plop a markdown file in a specific folder / with a specific naming and it will generate the correct badge and other markers.

Test completing a challenge!

We'd want a newish GitHub contributor to test walking through a challenge. I need to note that a lot of files in our docs repository are linked from here (that aren't merged yet) - I created the links with the intention that they would be there in time for CredCon.

Add syntax highlighting

It's only a matter of time until we want to include code around the site! Syntax highlighting should be added / properly tested (kramdown? rouge?) and a style file included if necessary. I've done a few of these before, but they are much uglier than other folks, so I'll leave this up to someone that is a better designer.