Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
113 lines (78 sloc) 5.8 KB

Contributing to Flynt

Thank you for taking the time to contribute! We'd love for you to contribute to our source code and make Flynt even better! Here are the guidelines we'd like you to follow:

Code of Conduct

Help us keep Flynt open and inclusive. Please read and follow our Code of Conduct.

Submission Guidelines

We use GitHub issues for each Flynt repository to keep track of all incoming queries (feature requests, bug reports, and questions). Please use the most relevant repository for submitting your issue:

Issues and Bugs

Before you submit your issue please search GitHub issues first, 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 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 or Use Case - Explain why this is a bug for you.
  • Flynt 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, 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).

Feature Requests

You can request a new feature by submitting an issue to the relevant GitHub Repository. If you would like to implement a new feature then consider what kind of change it is:

  • Major Changes should be discussed first in an issue so that we can better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.
  • Small Changes can be crafted and submitted to the relevant GitHub repository as a Pull Request.

Pull Requests

Before you submit a pull request please adhere to the following guidelines:

  • Search the relevant GitHub repository for an open or closed pull request that relates to your submission. You don't want to duplicate effort.

  • Fork the repo and make your changes in a new git branch.

git checkout -b myFixBranch master
  • If you are submitting a change for the Flynt Starter Theme, branch from the develop branch, not master.

  • Follow our Coding Rules.

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

  • Build and test your changes locally to ensure that everything works.

  • Push your branch to GitHub:

git push origin myFixBranch
  • In GitHub, send a pull request to the master branch. If you are submitting a pull request to the Flynt Starter Theme, send your pull request to the develop branch, not master.

  • If we suggest changes, then:

    • Make the required updates.
    • Re-test your code on your local environment.
    • Commit your changes to your branch (e.g. myFixBranch).
    • Push the changes to your forked GitHub repository (this will update your pull request).
  • If the pull request gets too out-dated, we may ask you to rebase and force push to update the pull request:

git rebase master -i
git push origin myFixBranch -f

WARNING: Squashing or reverting commits and force-pushing thereafter may remove GitHub comments on code that were previously made by you or others in your commits. Avoid any form of rebasing unless absolutely necessary.

That's it! Thank you for your contribution!

Coding Rules

Commit Messages

We follow the AngularJS git commit guidelines for all Flynt repositories. This leads to more readable and consistent messages that are easy to follow when looking through the project history. Please adhere to these guidelines.

The commit message formatting can be added using a typical git workflow or through the use of the CLI wizard Commitizen.

PHP

When writing PHP, follow the PSR-2 style guide.

JavaScript

When writing JavaScript, follow the Standard JS style guide.

Templates and Styles

When writing view templates or style files, please always: