Skip to content

Latest commit

 

History

History
34 lines (22 loc) · 1.54 KB

code-style.md

File metadata and controls

34 lines (22 loc) · 1.54 KB

Introduction

This is a brief introduction to how Open Knowledge Maps likes to style it's code in this project.

If you could help follow this then you'll make all our contributors lives easier and we can make cool things even faster!

Open Knowledge Maps and Vue

We're using vue with split files to make it easier for non-programmer contributors.

File layout

Public assets currently go into public Code goes into src Headline documentation (like this file) goes into the root (/)

Layout in src

Tests will go into __tests__ and be named after the component (or file) that they cover. Integration, Browser or End2End tests will go into separate folders as we implement them. Components are developed in split form so:

  • html/vue templates go into templates.
  • js goes into js

Prettier and JS Style

We're using prettier and airbnb with eslint to style the JS code in this project. Both JS in .vue files and in .js files. You can lint the code you've written with npm run lint Linting will also run before committing and warn you if you'll be committing non-compliant code.

SASS style

We’ll also be aiming to use AirBnB on our SASS files but we’re some way off that yet. Nevertheless, please follow the AirBnB CSS style guide for new SASS code.

Documentation

If you’re creating a new file (or changing its purpose) please add a short comment to the top of the file explaining its use so it’s easy for new contributors to understand our terminology.