Skip to content

Latest commit

 

History

History
46 lines (32 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

46 lines (32 loc) · 1.59 KB

Hello Contributor!

Thank you for considering contributing. Your input, ideas and productive criticism are much appreciated!

Introduction

These guidelines should help to communicate and collaborate with each other on this project. Following these guidelines helps to save time and to be more productive.

There are many ways to contribute like submitting bug reports or feature requests, improving documentation or writing tutorials. As already mentions every input is appreciated.

Ground Rules

Issue before PR

To save your own time and prevent frustration start by creating an issue before submitting a Pull Request. This way others can share their opinions on your input. Maybe there won't be a need for a code change or another solution can derive from your thoughts. As soon there is a need for code change, go for it and create a pull request!

It is time for Bullet Points

  • Be polite.
  • Ensure cross-platform compatibility (Windows, Mac, Linux).
  • Test your changes.
  • Discuss things transparently and get community feedback.
  • Keep feature versions small.

Creating Issues

When creating a new issue consider which of the following types this issue fits in the best and assign the correct label.

  • bug
  • feature request
  • change request

Commit Messages

Prefix commit messages with a package description it belongs to like follows:

  • [styleguide] change something
  • [eslint-config-base] change something
  • [eslint-config-react] change something
  • [eslint-config-angular] change something