Skip to content

Guidelines

Mathieu Cornic edited this page Sep 7, 2020 · 2 revisions

Guidelines of development on Learn:

  • Stay simple for the user by focusing on the mantra "convention over configuration". At installation, it should work without (m)any configuration. Default behavior can be overriden though;
  • Stay close to the Hugo way (we don't use npm or any preprocessing). Our users are not front-end developers;
  • Document new features in Example site;
  • Don't break existing features. If we have to do it, check with @matcornic first;
  • Create releases regularly, following Semver policy.
  • Contribute by passion in your free time, we should not feel pressure.
  • Obviously, don't infect code base

And finally, in every situation, we should be kind with contributors. Open Source should stay a welcoming community.

Clone this wiki locally