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

Latest commit

 

History

History
67 lines (44 loc) · 2.3 KB

CONTRIBUTING.md

File metadata and controls

67 lines (44 loc) · 2.3 KB
Raw

Contributing to Wet Lab Accelerator

You are free to enhance, extend, and modify Wet Lab Accelerator.

Project Roles

Maxwell Bates - Primary Maintainer + Developer

Florencio Mazzoldi - Business Owner

Submission Guidelines

Timing

We will attempt to address all issues and pull requests within one week. It may a bit longer before pull requests are actually merged, as they must be inspected and tested.

Issues

If your issue appears to be a bug, and hasn't been reported, open a new issue. Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. Providing the following information will increase the chances of your issue being dealt with quickly:

  • Overview of the Issue - if an error is being thrown a non-minified stack trace helps
  • Motivation for or Use Case - explain why this is a bug for you
  • Browsers and Operating System - is this a problem with all browsers or only IE8?
  • Reproduce the Error - provide a live example (using [Plunker][plunker] or [JSFiddle][jsfiddle]) or an unambiguous set of steps.
  • Related Issues - has a similar issue been reported before?
  • Suggest a Fix - if you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit)

Pull Requests

Before you submit your pull request consider the following guidelines:

  • Search GitHub for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.

  • Make your changes in a new git branch:

    git checkout -b my-fix-branch master

  • Create your patch.

  • Commit your changes using a descriptive commit message.

    git commit -a

    Note: the optional commit -a command line option will automatically "add" and "rm" edited files.

  • Push your branch to GitHub:

    git push origin my-fix-branch

  • In GitHub, send a pull request to wetlabaccelerator:master.

Coding Rules

  • Please maintain a code style similar to that of the rest of the project.
  • Please document all public methods.

Tests

We have only included minimal tests, in the folder /QA/. We would hugely appreciate the contribution of tests. Please make sure that your contributions maintain the fidelity of that test suite.