Skip to content

Latest commit

 

History

History
34 lines (27 loc) · 2.64 KB

CONTRIBUTING.md

File metadata and controls

34 lines (27 loc) · 2.64 KB
Raw

Contribute to Foundation for Apps

ZURB loves its community! We always want to hear from our users, whether they're reporting bugs, suggesting new features, or even adding them themselves.

Reporting Bugs

Open a new issue to report a problem you're having with Foundation for Apps. When writing your issue, keep these things in mind:

  • Be descriptive. If you can, upload a screenshot of problem you're having, or copy and paste any JavaScript or command line errors you encounter. Being detailed will help us hone in on the problem faster.
  • Post your code. It's very helpful to see any HTML, Sass, or JavaScript you've written that you think may be causing the problem. In some cases, we might be able to fix your problem just by fixing your code.
  • Help us recreate it. If your problem is complex, tell us the steps needed to recreate the issue. Sometimes we need to see the problem for ourselves, in our own web browsers, so we can more easily debug it.
  • Tag your issue. Tagging your issue helps us categorize it.
    • bug: Use for problems with the framework.
    • question: Use if you need clarification about how a component works.
    • feature: Use if you have an idea for a new feature, or a way to improve an existing one.
    • codebase: Use if you think the framework's Sass or JavaScript needs to be adjusted in some way.
      • And of course, if you're feeling especially daring, you can submit a pull request and make changes yourself :)
    • You can also add the sass, javascript, docs, cli, or iconic tags to specify what component of the framework your issue is about.

Submitting Pull Requests

If you think you can solve a problem yourself, or want to implement a new feature, go for it! Follow these guidelines to make the most killer PR ever.

  • Test, test, and test. The Foundation frameworks are used by thousands and thousands of designers and developers, so making sure your changes work in every browser is important! Foundation for Apps is officially supported on:
    • Newest Chrome
    • Newest Firefox
    • Safari 7+
    • Internet Explorer 10+
    • Mobile Safari 7+
    • Android Browser 4+
  • When changing or adding Sass code, follow these steps:
    • If you modify a variable's default value, make the change on the component itself, the settings file, and the component's page on the documentation.
    • If you add a new variable, follow our rules for variable names.
    • If you change a mixin's parameters, find the component's mixin documentation and change the parameters there as well.