Skip to content

Latest commit

 

History

History
107 lines (83 loc) · 3.94 KB

CONTRIBUTING.md

File metadata and controls

107 lines (83 loc) · 3.94 KB
Raw

Welcome contributors to Alva

💓 First of all, we'd love for you to contribute to our source code. 💓

Code of Conduct

We belive in a welcoming and inclusive environment / community, that's why we enforce our Code of Conduct. For more information -> Contributor Covenant Code of Conduct.

Table of Contents

Short collection of Links to Important Resources

Setup for contributers

To add a contribution to Alva (improve its features, fix issues), get the source of the application itself, and if you don´t already have a Alva compatible styleguide, the kickstart styleguide (designkit):

  1. Clone the alva repository:
git clone git@github.com:meetalva/alva.git
  1. Run in the main (Alva) respository:
npm i && npm start
  1. Now open a compatible styleguide.

If you don´t have any, follow the next steps

  1. Clone the designkit repository: 
    git clone git@github.com:meetalva/designkit.git
  2. Run this command to build the designkit for Alva: 
    npm i && npm start
    Now you should be able to open the designkit inside Alva

Issues

Good first issue

A good first issues for contribution could be

  • reporting a bug
  • create a feature request
  • work on an issue with the label good first issue

Labels

  • good first issue - if you are new to Alva or open source this could be a good first issue
  • help wanted - issue where we need help
  • type: bug - issue for an error/ failure of Alva
  • type: feature - issue for feature request
  • type: design - issue for a design todo
  • type: documentation - issue for needed, missing or unclear documentation
  • status: in progress - issue is currently in progress
  • status: has PR - issue has already an open pull request
  • priority: low - issue which is a nice to have, like a backlog issue
  • priority: mid - issue needed in the near future, but not super urgent
  • priority: high - issue must be resolved as soon as possible

Working on issues

Issues should be provided as branches starting with "feat/", as pull requests.

Style Guide / Coding conventions

Coding conventions & guidelines

TypeScript & TSLint

We use strict tsconfig and TSLint rules, as well as Prettier. When it comes to naming things, we follow the TypeScript guidelines, and we do not abbreviate names (except for trivial names like HTML).

We use .editorconfig

Editorconfig helps developers define and maintain consistent coding styles between different editors and IDEs. There are a lot of plugins for editors/IDEs that support .editorconfig.

You'll find more informations, extentions for editors and IDEs at the editorconfig page.

Commit message conventions

For commit message we use the angular commit guidelines

commitizen & commitlint

https://github.com/marionebl/commitlint https://github.com/commitizen/cz-cli

Team

  • Alexander Peschel
  • Julius Walther
  • Lasse Küchler
  • Markus Ölhafen
  • Tilman Frick
  • Thomas Jacob

Questions?

Just drop us an email or write a direct message on Twitter to @meetalva