Permalink
d65a3f7 Sep 25, 2016
@Dogfalo @ProfNandaa @acburst
95 lines (69 sloc) 5.67 KB

Contributing

  • Compiling Files
    • npm install
    • grunt monitor, this will compile .scss, .js., .jade files
  • Documentation
    • If you notice an error in the documentation, please edit the corresponding .html page under jade/page-contents/.
  • Issues
    • If you have an issue please make sure you document the problems in depth.
    • Create screenshots of your issue and include a Codepen of the problem where applicable
    • Unclear issues with little explanations will be closed.
    • Issues without a Codepen (where applicable) will be closed or ignored.
  • Feature Requests
    • We like feature requests but make sure that it can be seen within the goals of the project and not just something you need individually. Also you should try and give as much examples and details about the new feature as possible.
  • Code Examples
    • Use this Codepen to illustrate your problem.

Contribution 101

  • Fork this repo to your own git
  • Make your changes
  • Submit a pull request with full remarks documenting your changes
  • Pull request MAY then be accepted by project creators
  • Make sure you are altering the correct source files (Never alter compiled / dist files)

Jasmine Testing Guide

References:

Before you start, make sure you install grunt and all its dependencies. To verify you have all the correct dependencies you can run grunt travis and it will run the tests. If you get an errors and have not made any changes, it means you have not installed the proper dependencies.

Materialize uses Jasmine as the testing framework. We also include a jQuery library which allows you to write tests using jQuery syntax.

Starting Out

First to familiarize yourself with how the tests are structured, you can take a look inside the tests/ directory. Each component should have its own folder. Follow the file-naming conventions that are used in the existing tests.

Before writing tests, make sure you are working off of a clean git branch of your fork. This will greatly simplify the Pull Request process.

Writing Tests

Before writing tests, make sure you understand what the expected-behavior of the component actually is. Reading over the component code and documentation will greatly aid you in this regard.

Use describe blocks to section disparate portions of tests and it blocks inside those to further break up tests into features. Inside it blocks, you can have multiple except statements. As a general testing principle, be sure to try and test both the case and its “inverse” to lessen the chance for false positives.

Example:

expect(toast.first('span').text()).toBe('I am toast content');
expect(toast.first('span').text()).not.toBe('I am toast');

You can use beforeEach, and afterEach in either block to designate code that will execute before or after each item. This is useful if you need to setup some scenario for each test, or reset some things after each test.

When writing expect statements (Jasmine’s form of assert), it is very important to write an expected behavior string so in the event of an error, the test that failed is very clear.

Example:

expect(toast.length).toBe(0, 'because toast should be removed by now');

When this expect statement fails it will list the reason as “because toast should be removed by now”.

Because our components are very front end heavy, familiarize yourself with jQuery ways of interacting with the dom and our components. You can use methods like trigger, to simulate certain events like the user clicking a button.

We also understand that testing CSS properties is pretty tough so you’ll have to be creative when writing good tests that ensure the styling is still working. Try and cover as many cases as you can but don’t worry if there are some edge cases. You can add comments describing some problematic edge cases in TODOs so we know about them.

Submitting Your Pull Request

Try and keep your commit history clean and concise. Once you submit your pull request, Travis CI will automatically run your tests and will show a checkmark to show that all the tests have passed. Once this is done, we’ll review your tests and code and make comments if there are issues or things we think could be improved. Then once everything looks good we’ll merge the code in!

Useful Jasmine Tips

  1. To only run a specific spec at a time, to avoid wasting your time running all our other tests, you can set the flag --filter. For example:

    `grunt travis --filter=tabs`
    

    This would only run specs with tabs in its name.

  2. If you need a timeout in your test (waiting for some animation or action to be executed) you need to use the done callback. In your it() behavior function set done as an argument to your anonymous function. Then you can use javascript’s window setTimeouts normally. And when you want the test to finish just call the done() function. For example:

    it ('should wait for a timeout', function(done) {
      // Execute action
      timeout(setTimeout(function() {
        // Wait a second
        // Test for result
        done();
      }, 1000);
    });

    Note: If you add done as a callback, and you don’t call the done() function, it will stall forever and error after a max limit of around 5 seconds.