Skip to content

g-javi/community-platform

 
 

Repository files navigation

Zen, the CoderDojo Community Platform

Welcome to 'Zen'! You can see the live site at zen.coderdojo.com.

Contributing to Zen

There are various ways to contribute to Zen:

  • as a developer, instructions for creating a local development environment can be found in the 'local dev' repository. You may also wish to read the contributing guide.
  • as a translator, we use CrowdIn to help manage localisation, please sign up and help out!
  • issue management, we keep track of all our issues in GitHub in this repo, help out here
  • documentation, by contributing to the documentation in this repository.

Where to begin

View our Speaker Deck!

There are a few labels in particular that are very useful if you are new to Zen:

  • The suitable for beginners label marks anything considered easy enough for a first time contributor.
  • The request for comments label is great for non-coders or people wishing to get familiar with the system. These are often features we are not sure if we want to produce yet, or issues that require clearer implementation guidelines.
  • The hints provided label is attached to anything which has been given a technical spec by someone on the development team.

Bug fixes

  • Ideally all of the bugs are the most important issues to fix. They are categorised by priority.
  • There is a critical bugs milestone for the most important bugs.
  • Some bugs are smaller CSS issues that are marked low priority and so are not as important to work on.

Priorities for the project

Once you're familiar with the codebase, there are a number of labels/milestones to guide you through our roadmap.

Working on an issue?

  • Comment on it and let us know so we don't duplicate any effort.
  • We can add you to the official CoderDojo development team so you can assign yourself issues.
  • Tag @tangentfairy if you have any questions

Developer Support

  • The CoderDojo Foundation Technical Lead is available to help you get set up.
  • We can add you to the Foundation Slack community for daily communications. Please get in touch to be added!
  • To get in touch, email us at [email protected]
  • To deploy a change, you'll need to get in touch as only those with commit access can do so.
  • Have a read through closed pull requests in the frontend repository to get a feel for what we have been working on.

License

The Community Platform (Zen) is copyright The CoderDojo Foundation, and open sourced under the MIT license.

Documentation

The following is a list of further reading:

  • Architecture - a high level overview of the system, the code layout, etc
  • Localisation - some notes on localisation
  • Forums - some developer notes on the forums

About

Zen, the CoderDojo Community Platform!

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 99.6%
  • Shell 0.4%