Skip to content

Latest commit

 

History

History
39 lines (25 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

39 lines (25 loc) · 1.59 KB

Contributing to Jmix

We welcome your contributions to Jmix! There are multiple ways to do it.

Participating in Discussions

Join us at https://forum.jmix.io or ask questions on StackOverflow with the jmix tag.

Reporting Bugs

We use Github issues for a backlog of bugs, improvements and feature requests related to the framework. The backlog contains issues for both open-source and premium modules.

If you found a bug in Jmix Studio, report it on the forum with the studio tag. Studio bugtracker is read-only for the public, so we'll create an issue based on your report, and you will be able to track its progress.

Contributing Code or Documentation

All our projects accept contributions as GitHub pull requests. The first time you create a pull request, you will be asked to electronically sign a contribution agreement (CLA).

The process:

  1. Fork the repository
  2. Fix an issue or create an issue and fix it
  3. Create a pull request, check "Allow edits from maintainers"
  4. Sign a CLA
  5. Respond to review comments
  6. Wait for merge and release

Working with Code

  • Install JDK 8
  • Install IntelliJ IDEA
  • Import build.gradle file of the project into the IDE
  • Work on your issue
  • When finished, run tests: ./gradlew test
  • Install to the local Maven repo: ./gradlew publishToMavenLocal and test locally on an application.

Working with Documentation

Fork the jmix-docs repository and see building instructions in its README.