Skip to content
This repository has been archived by the owner on Oct 11, 2024. It is now read-only.

Latest commit

 

History

History
35 lines (19 loc) · 2.41 KB

CONTRIBUTING.md

File metadata and controls

35 lines (19 loc) · 2.41 KB
Raw

Liferay Screens Contribution Guide

Before contributing to Liferay Screens, make sure that you have done the following:

  1. Read the architecture tutorial for the platform you're contributing to:

  2. Read the coding style guide for the platform you're contributing to:

  3. Sign up for our issue tracker and go to the Liferay Screens page.

  4. Fork this repository.

Making Contributions

Follow these steps if you know the feature that you want to add, and how to add it:

  1. Add your new feature as a Story in our issue tracker. Describe your feature's purpose, benefits, and details. Also make sure to associate your feature with one specific Epic.

  2. Create a branch for your feature.

  3. When you make commits, prefix the commit message with LMW-xx, where xx is the Story number in the issue tracker. Try to arrange your commits in such a way that revisions are easier to make.

  4. Push your branch to your repository and create a pull request to the liferay-screens master branch.

Determining Your Contributions

What happens when you want to make a contribution, but you're not sure about it, or you don't know how to implement it? No problem! One thing you can do is open a thread in our forum. We're always happy to discuss new ideas.

If you have a good idea for a feature but don't know how to implement it, you can add a Feature Request to our issue tracker. When doing so, be sure to describe the benefits of the feature and why you think it's useful. We'll then review and prioritize it.