Skip to content

Latest commit

 

History

History
42 lines (29 loc) · 2.58 KB

CONTRIBUTING.md

File metadata and controls

42 lines (29 loc) · 2.58 KB
Raw

Contributing to Joinfaces

Using GitHub Issues

We use GitHub issues to track bugs and enhancements.

If you are reporting a bug, please help to speed up problem diagnosis by providing as much information as possible. Ideally, that would include a small sample project that reproduces the problem.

Working with the Code

Project Structure

This software is multi module Gradle project and follows Spring Boot Reference to create JSF Auto Configuration. See what's inside each submodule.

Branching

This repository follows the same branching model like the Spring Framework and Spring Boot repositories:

  • The master-branch always contains the latest code, targeting the latest Spring Boot version.
  • Additional branches, which are named like version numbers contain the code of older, but still supported version series.

The master-branch could contain Joinfaces 3.x which targets the upcoming Spring Boot 2.0.0 while the 2.x-branch contains Joinfaces 2.x which targets Spring Boot 1.5.x. (The exact version numbers and branch names will change over time, but the principle stays the same.)

If you want to contribute to Joinfaces, make sure you start your work on the head of the correct branch. Make also sure, to select the same branch as base when creating your pull request.

Code Conventions and Housekeeping

This section is mainly copied from https://github.com/spring-projects/spring-boot/blob/master/CONTRIBUTING.adoc

None of these is essential for a pull request, but they will all help. They can also be added after the original pull request but before a merge.

  • Make sure all new .java files to have a simple Javadoc class comment with at least an @author tag identifying you, and preferably at least a paragraph on what the class is for.
  • Add the license header comment to all new .java files (copy from existing files in the project)
  • Add yourself as an @author to the .java files that you modify substantially (more than cosmetic changes).
  • Add some Javadocs.
  • A few unit tests would help a lot as well -- someone has to do it.
  • When writing a commit message please follow these conventions.