Skip to content

Latest commit

 

History

History
166 lines (114 loc) · 6.84 KB

CONTRIBUTING.md

File metadata and controls

166 lines (114 loc) · 6.84 KB
Raw
options tags
order
0
contributing

Welcome Contributors

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

Code of Conduct

We believe in a welcoming and inclusive environment / community, that's why we enforce our Code of Conduct. See the Contributor Covenant Code of Conduct for more information.

Table of Contents

Short collection of Links to Important Resources

Setup for contributors

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) repository:
npm i && npm start

(Note: Please use npm only. We dropped the support for Yarn for now, as we wired our release process to the package-lock.json file.)

  1. Now open a compatible styleguide.

If you don't have a compatible styleguide, follow the next steps:

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

Typedoc

To generate a Typedoc documentation of all classes, run

npm run docs

then open build/docs/globals.html in your browser.

Issues

Good first contribution

A good first 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
  • type: feedback - issue for feedback and task where we need to figure out if it's a bug or we want it as a feature (or something else)
  • type: question - issue for open question (most of the time, they need to be answered by core team)
  • 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.

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 information, extensions for editors and IDEs at the editorconfig page.

Commit message conventions

For commit messages we use the angular commit guidelines with one exception: Please put the GitHub issue reference into the header, e.g.

feat(store): patterns path configurable (fixes #214)

As tools, we use commitlint and commitizen.

Source-code structure and architecture

Alva is a React application using MobX as state management and Electron to provide a stand-alone application.

Additionally, it ships with a living styleguide project, which consists of Patternplate React components.

All the sources of Alva are located in src, divided into the following folders:

  • components: All React components for the project, page, page-element, and property panes, as well as the design preview in the middle of the page. Components may be smart (they may contain their own state), but only as long as the state is nothing global, related to multiple components, or fundamental enough. In this case, the state is maintained by the store (see below).
  • electron: The bootstrap code to start the Electron App, including the container HTML, and the main menu.
  • lsg: The styled components Alva uses, as a living styleguide. Do not mixup this styleguide with the designkit (which also is a styleguide). The LSG contains the styled, logic-less components which are used by the Alva UI. The designkit contains the patterns the designer uses to create a basic design (wireframes).
  • resources: Resources are files related to the build, like the icons.
  • store: The store is the data-center and business logic of Alva. It is a collection of MobX observables and does not contain any UI elements like React components. Instead, all components bind their props to this store by decorating with @MobX.observer. The store contains the Alva projects and pages the user edits, as well as the styleguide and styleguide analyzers, the logic to interpret your frontend pattern components.

Team

Questions?

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