Skip to content

Latest commit

 

History

History
27 lines (20 loc) · 1.95 KB

CONTRIBUTING.md

File metadata and controls

27 lines (20 loc) · 1.95 KB
Raw

Contribute to Angular Base Apps

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 Angular Base. 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.

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 Angular Base framework is used by thousands and thousands of designers and developers, so making sure your changes work in every browser is important! Angular Base 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 change anything about the settings variables for a component, run gulp sass:settings to generate a new settings file.
    • 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.