Like the most active of you have already noticed, Vaadin has been moving its open source functions to GitHub. Today, we can finally say we are there. Vaadin Framework is the biggest and the most important project to adapt a fully GitHub based workflow.
What does this mean to you?
In short: forget Trac and Gerrit, GitHub is used for everything. This makes participating easier and more familiar for many OSS contributors. The main repositories are now hosted in GitHub and changes are reviewed as basic pull requests. Bug reports and enhancement ideas are now in GitHub as well. The well served Trac service is now in read only state and all existing issues were moved to GitHub.
Our professional services, like Bug Fix Priority, are now also referring to GitHub issues.
Reporting a bug or an enhancement idea
To report a new bug, follow this basic process:
-
If you don’t have one already, create a GitHub account
-
Choose the correct project from github.com/vaadin, e.g. vaadin/framework for Vaadin Framework
-
Search existing issues as somebody else might have already faced the same issue. If you have more details of the issue, comment on the existing issue. You can also otherwise let the team know the issue is important, by commenting or adding a thumb up emoji or something. You can also subscribe to the issue to be notified about changes in the issue.
-
If there was no issue yet, create a new one. Add clear details of how to reproduce the issue and attach a reduced test case if possible.
Contributing code
If you want to go a bit further, you can also provide code that fixes bugs or adds cool new features. In that case:
-
Fork the project of your choice from github.com/vaadin
-
Create a pull request, one per fix/feature. Use separate branches for separate changes.
-
On pull request, ensure you have a contribution licence agreed, the pull request reports this automatically.
-
Wait for the team to review the changes either directly in GitHub or using Reviewable.
As a summary, participating in any Vaadin project just got much simpler! Individual projects have some more detailed instructions on how to setup development environment and run tests.