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.9KB

12345678910111213141516171819202122232425262728293031323334
  1. # Vaadin Framework Contribution Guidelines
  2. ## Project setup
  3. See the repository [root level README](https://github.com/vaadin/framework/blob/master/README.md) for instructions on setting up the environment to keep up the formatting and code style.
  4. ## Pull Requests
  5. ### Making your PR
  6. A new pull request should start by forking the Vaadin Framework project (or checking that your fork is up-to-date).
  7. Unless the issue is specific to a single version of the Framework, you should always aim to make the patch on top of the `master` branch.
  8. In your repo, make a new branch from `master`. Make your code changes in that branch, and once you're done make a pull request to the `vaadin/framework` branch `master`.
  9. We recommend making sure that the "Allow edits from maintainers" checkbox on the pull request page is checked. This allows us to commit minor fixes, like correcting typos, without bothering you.
  10. ### Getting feedback and responding to it
  11. Once the pull request has been opened, it will be reviewed by the development team behind Vaadin Framework. We pay close attention to the readability of the code as well as documentation and correctness.
  12. If this was your first pull request to the Vaadin repository, you will also have to sign our CLA. This needs to be done with the same user you use to make the commits. If you're using multiple e-mails and GitHub users, each will need to sign the CLA.
  13. ## Issues
  14. Only use GitHub issues for bugs and feature requests. For general support from the community, see https://vaadin.com/forum
  15. For bugs, please provide at minimum the following information:
  16. - Vaadin version
  17. - Description of the bug
  18. - If possible, minimal reproducible example
  19. We use the label `good first issue` to mark easy issues to get started with. The list is available [here](https://github.com/vaadin/framework/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).