diff options
| author | Yuriy Yevstihnyeyev <yuriy@vaadin.com> | 2018-07-24 11:01:53 +0300 |
|---|---|---|
| committer | Manuel Carrasco Moñino <manolo@apache.org> | 2018-07-24 10:01:53 +0200 |
| commit | 7c3c58be0de7f7ad10abe93c31b9b2c20ef99672 (patch) | |
| tree | 02cd6023bd228e8dd750b7c1c4f956cf896b8116 /CONTRIBUTING.md | |
| parent | 6149f2543244d5f38f65ac9cc8ba1d03ab9bf349 (diff) | |
| download | vaadin-core-7c3c58be0de7f7ad10abe93c31b9b2c20ef99672.tar.gz vaadin-core-7c3c58be0de7f7ad10abe93c31b9b2c20ef99672.zip | |
Add contribution.md (#190)
* Add contributing.md
* Simplify wording
* Make a noot about polymer analyze
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9e5ecd8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,51 @@ +## Contributing + +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. + +To submit a PR follow these minimum requirements: + + - Make sure your code is compliant with our code linters: `gulp lint` + - Check that tests are passing: `polymer test` + - [Submit a pull request](https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github) with detailed title and description + - Wait for response from one of Vaadin components team members + +We will review the PR and make a decision on it. + +### Advanced requirements + +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. + + - 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) + + - 100% coverage with automated tests + - Should pass on each supported platform (desktop/mobile): + - Chrome (latest, any platform) + - Firefox (latest, any platform) + - Safari (latest, any platform) + - Edge (latest, any platform) + - IE11 (any platform) + - iOS Safari (9, latest, any platform) + - Chrome on Android (latest, any platform) + + - Live Demo with a code example demonstarting the feature + - Not required for a bug fix + + - Documented + - visual parts + - elements + - events + - attributes exposed for styling + - public properties and methods + + - Accessible + + - Visuals are themable: + - **Supports both lumo and material themes** + - theming parts / state attributes are exposed + - documented + - covered with visual tests (optional) + + - I18n compatible + + - RTL (optional) + |