Contributing to Ignite UI

Overview

Ignite UI OSS version accepts contributions, as long as they follow the guidelines explained below. When contributing you would have to follow these steps:

1. Fork the repository
2. Perform the changes in your fork
3. Create a pull request with your changes and reference the issue you're working on

Your pull request will undergo a review and if approved will be merged. All checks for the pull request should pass before a pull request is merged.

Fixing a bug

When fixing a bug you need to follow these guidelines:

1. Leave a comment above your change in the format <initials> <date> <Issue Number|Issue Link> <Comment for the change>
   • e.g. K.D. June 28th, 2016 #1234 Adding this comment as an example
   • e.g. K.D. June 28th, 2016 https://github.com/IgniteUI/ignite-ui/issues/1234 Adding this comment as an example
2. Write unit tests that cover your change. The test should fail prior to your change and pass after it
3. Run JSHint, JSCS, Unit tests and make sure they all pass
4. Pull request your changes and reference the issue

New feature development

In order to contribute code to a new feature, you need to follow these guidelines.

1. Work on implementation in your fork
2. Follow a test-driven development process (TDD) to ensure full code coverage, or make sure that you include unit tests that cover all of the newly added code
3. Document all newly added public methods, events, and options Documentation Guideline
4. Make sure all static code analysis and unit tests pass before opening a pull request
5. Reference the issue you've been working on in your pull request