Skip to content

Latest commit

 

History

History
56 lines (40 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

56 lines (40 loc) · 1.55 KB

CONTRIBUTING

When contributing to this repository, please first discuss the change you wish to make via issues.

Please note if you are working on a certain issue then make sure to stay active with development.

Git Commit, Branch, and PR Naming Conventions

When you are working with git, please be sure to follow the conventions below on your pull requests, branches, and commits:

PR Title: #[ISSUE ID] Title of the PR
PR Description: [OPTIONAL EXTRA INFORMATION] + closes #[ISSUE ID]
Branch: [ISSUE ID]-title-of-the-pr (shorter)
Commit: #[ISSUE ID] what was done

Examples:

PR Title: #2 Add builder inheritence
PR Description: closes #2
Branch: 2-add-builder-inheritence
Commit: #2 add builder inheritence

Installation

To get started with Builder-Generator locally, follow these steps

  1. Fork the repo

  2. Clone your fork

  3. Navigate to the project directory

  4. Build with mvn

    mvn verify

Working on New Features

If you want to work on a new feature, follow these steps.

  1. Create or choose an issue
  2. Fork the repo
  3. Clone your fork
  4. Checkout a new branch
  5. Do your work
  6. Commit
  7. Push your branch to your fork
  8. Go into github UI and create a PR from your fork & branch.

Explanation of Structure

The Type class is the equivalent of a java class, while the TypeMember class is the equivalent of a field, method, or class inside a java class. In case that a TypeMember is a class then the toType method can be used to handle the usage of it as a Type.