Skip to content

Latest commit

 

History

History
154 lines (107 loc) · 5.39 KB

CONTRIBUTING.MD

File metadata and controls

154 lines (107 loc) · 5.39 KB

Contributing to AoflJS

We welcome anyone to contribute to our source code to make AoflJS even better than it is today! Before contributing please familiarize yourself with our guidelines:

Code of Conduct

Before contributing please read and follow our Code of Conduct and read our Coding Rules that adds a few exceptions to Google's JavaScript Style Guide. To ensure consistency throughout the source code keep these rules in mind as you are working.

Questions, Bugs, Features

Questions and General Support

Do not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests. Instead please direct all general support questions to [TBD]

We will close all issues that are requests for general support and redirect people here.

Bug and Issue Reporting

If you find a bug in the source code, you can help us by submitting an issue to our GitHub Repository. Even better, you can submit a pull request with a fix.

Please see the Submission Guidelines below.

Feature Requests

You can request a new feature by submitting an issue to our GitHub Repository.

  • Major Changes should be discussed first in a GitHub issue that outlines the changes and benefits of the feature.
  • Small Changes can be submitted to the GitHub Repository as a pull request.

Doc Fixes

If you have a suggestion for the documentation, you can open an issue and outline the problem or improvement you have or you can create the doc fix yourself!

For large fixes, please build and test the documentation before submitting the PR to be sure you haven't accidentally introduced any layout or formatting issues.

Git Commit Guidelines

We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history. But also, we use the git commit messages to generate the change log.

Commit Message format

Each commit message should list all performance improvements, feature changes, and bugfixes.

feature-branch-name

Performance:
  - component name:
    - list of performance improvements

Features:
  - component name:
    - list of new features

Bugfixes:
  - component name:
    - list of bugfixes

Issue Submission Guidelines

Before you submit your issue search the archive, maybe your question was already answered.

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.

Provide as many of the following to ensure a faster response:

  • 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
  • AoflJS Version(s) - is it a regression?
  • Browsers and Operating System - is this a problem with all browsers or only specific ones?
  • Reproduce the Error - provide a live example (using Plunker or JSFiddle) or a set of steps to recreate the bug.
  • 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 Request Submission Guidelines

Before you submit your pull request consider the following guidelines:

  • Search for an similar open or closed pull requests before beginning

  • Fork the repo

  • Make your changes in a new git branch:

    git checkout -b my-branch

  • Create your patch commit.

  • Squash your commits.

  • Follow our Coding Rules.

  • Commit your changes using a descriptive commit message that follows our commit guidelines

That's it! Thank you for your contribution!

After your pull request is merged

After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:

  • Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:

    git push origin --delete my-branch

  • Check out the master branch:

    git checkout master -f

  • Delete the local branch:

    git branch -D my-branch

  • Update your master with the latest upstream version:

    git pull --ff upstream master