Skip to content

Latest commit

 

History

History
39 lines (22 loc) · 2.13 KB

CONTRIBUTING.md

File metadata and controls

39 lines (22 loc) · 2.13 KB

ABibliaDigital Contributing Guide

Before submitting your contribution please read the guidelines.

Commit Guidelines

Commit messages should follow the commit message convention.

Issue Reporting Guidelines

  • Do not create questions. The issue list is exclusively for reports, bugs and feature requests. Use the Twitter instead.

  • Always search for your issue first. It may have already been answered, planned or fixed in some branch. New features will be planned on Trello.

  • Only create issues for the newest version.

  • Create a declarative title and describe clearly the steps necessary to reproduce the issue. If an issue labeled "need repro" receives no further input from the issue author for more than 3 days, it will be closed.

  • If you want to show your code please use Codepen or JSFiddle or Postman

  • In case you found a solution by yourself try to explain how you fixed it. It could be useful for somebody else. 😃

Pull Request Guidelines

  • The master branch is basically just a snapshot of the latest stable release. All development should be done in dedicated branches. Do not submit PRs against the master branch.

  • Make small commits as you work on the PR. They will be automatically squashed before merging.

  • Provide convincing reason to add a new feature. Ideally you should open a suggestion/request issue first and have it greenlighted before working on it.

  • If fixing a bug:

    • If you are resolving a special issue, add the GitHub ID to your commit. E.g. (fix something really ugly #xxx)
    • Provide detailed description of the bug in the PR.

Contribution based on the vue-material and docz contribution files