You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

CONTRIBUTING.md 1.8KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. ## Contributing
  2. Dear contributor, we are glad that you want to improve our product. Our products have high quality requirements, all the changes should satisfy those as well.
  3. To submit a PR follow these minimum requirements:
  4. - Make sure your code is compliant with our code linters: `gulp lint`
  5. - Check that tests are passing: `polymer test`
  6. - [Submit a pull request](https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github) with detailed title and description
  7. - Wait for response from one of Vaadin components team members
  8. We will review the PR and make a decision on it.
  9. ### Advanced requirements
  10. Advanced requirements affect the PR handling time. The more requirements are met, the sooner PR will be merged. Otherwise, we will take care of those missing parts in case of PR approvement.
  11. - Minimal API to fulfill the requirements of the idea (when modifying the API do not forget to to run `polymer analyze` to update analysis file)
  12. - 100% coverage with automated tests
  13. - Should pass on each supported platform (desktop/mobile):
  14. - Chrome (latest, any platform)
  15. - Firefox (latest, any platform)
  16. - Safari (latest, any platform)
  17. - Edge (latest, any platform)
  18. - IE11 (any platform)
  19. - iOS Safari (9, latest, any platform)
  20. - Chrome on Android (latest, any platform)
  21. - Live Demo with a code example demonstarting the feature
  22. - Not required for a bug fix
  23. - Documented
  24. - visual parts
  25. - elements
  26. - events
  27. - attributes exposed for styling
  28. - public properties and methods
  29. - Accessible
  30. - Visuals are themable:
  31. - **Supports both lumo and material themes**
  32. - theming parts / state attributes are exposed
  33. - documented
  34. - covered with visual tests (optional)
  35. - I18n compatible
  36. - RTL (optional)