Skip to content
This repository has been archived by the owner on Oct 19, 2023. It is now read-only.

Latest commit

 

History

History
27 lines (21 loc) · 1.16 KB

CONTRIBUTING.md

File metadata and controls

27 lines (21 loc) · 1.16 KB
Raw

Contributing to lib-apidoc

Issue Tracker

If you have an questions about how to use lib-apidoc, create an issue and apply the question label.

If you have a bug to report please use the example format below or it may not be picked up by a contributor. Apply the bug label to the issue.

A short title / description of the bug.

A summary of the issue and the environment in which it is occurring. Important information examples are: Browser vendor / version, OS, runtime environment.

If applicable, the steps to reproduce the bug:

  1. The first step
  2. The second step
  3. The third step

<link> - A pull request or codepen, etc to a test case or example of the bug

The expected outcome or results of the code was functioning as expected

Any other relevant information that will help code contributors resolve the issue

Code Style

We use .editorconfig and eslint to enforce code quality standards. Please make sure your text editor is utilizing the editorconfig. The travis build will fail if eslint does not pass, so it's also recommended that your editor lints your code as you're writing it to avoid head aches when submitting pull request.