Skip to content
This repository has been archived by the owner on Mar 21, 2021. It is now read-only.

Latest commit

 

History

History
199 lines (140 loc) · 10.1 KB

CONTRIBUTING.md

File metadata and controls

199 lines (140 loc) · 10.1 KB
Raw

Contributing to JHipster

Are you ready to contribute to JHipster core? We'd love to have you on board, and we will help you as much as we can. Here are the guidelines we'd like you to follow so that we can be of more help:

And don't forget we also accept financial contributions to the project using OpenCollective.

Questions and help

This is the JHipster core bug tracker, and it is used for Issues and Bugs and for Feature Requests. It is not a help desk or a support forum.

If you have a question on using JHipster, or if you need help with your JHipster core project, please read our help page and use the JHipster tag on StackOverflow or join our Gitter.im chat room.

Issues and Bugs

If you find a bug in the source code or a mistake in the documentation, you can help us by submitting a ticket to our GitHub issues. Even better, you can submit a Pull Request to our JHipster core project or to our Documentation project.

Please see the Submission Guidelines below.

Feature Requests

You can request a new feature by submitting a ticket to our GitHub issues. If you would like to implement a new feature then consider what kind of change it is:

  • Major Changes that you wish to contribute to the project should be discussed first. Please open a ticket which clearly states that it is a feature request in the title and explain clearly what you want to achieve in the description, and the JHipster team will discuss with you what should be done in that ticket. You can then start working on a Pull Request.
  • Small Changes can be proposed without any discussion. Open up a ticket which clearly states that it is a feature request in the title. Explain your change in the description, and you can propose a Pull Request straight away.

Submission Guidelines

Submitting an Issue

Before you submit your issue search the archive, maybe your question was already answered.

If your issue appears to be a bug, and has not been reported, open a new issue. Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. Providing the following information will increase the chances of your issue being dealt with quickly:

  • The issue - Explain the bug or feature request, if an error is being thrown a stack trace helps
  • Motivation for or Use Case - Explain why this is a bug for you
  • Reproduce the error - An unambiguous set of steps to reproduce the error. If you have a JavaScript error, maybe you can provide a live example with JSFiddle?
  • Related issues - Has a similar issue been reported before?
  • Suggest a Fix - If you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit)
  • The XMI file - Your XMI file, if you can't paste it, mail it.
  • Versions - JHipster version, JHipster core version and the editor

Click here to open a bug issue with a pre-filled template. For feature requests and enquiries you can use this template.

Issues opened without any of these info will be closed without any explanation.

Submitting a Pull Request

Before you submit your pull request consider the following guidelines:

  • Search GitHub for an open or closed Pull Request that relates to your submission.
  • In GitHub, send a pull request to jhipster/jhipster-core:master.
  • If we suggest changes then

    • Make the required updates.

    • Re-run the JHipster core tests on your sample generated project to ensure tests are still passing.

    • Rebase your branch and force push to your GitHub repository (this will update your Pull Request):

      git rebase master -i
git push -f

That's it! Thank you for your contribution!

Resolving merge conflicts ("This branch has conflicts that must be resolved")

Sometimes your PR will have merge conflicts with the upstream repository's master branch. There are several ways to solve this but if not done correctly this can end up as a true nightmare. So here is one method that works quite well.

  • First, fetch the latest information from the master

    git fetch upstream

  • Rebase your branch against the upstream/master

    git rebase upstream/master

  • Git will stop rebasing at the first merge conflict and indicate which file is in conflict. Edit the file, resolve the conflict then

    git add <the file that was in conflict>
git rebase --continue

  • The rebase will continue up to the next conflict. Repeat the previous step until all files are merged and the rebase ends successfully.

  • Re-run the JHipster tests on your sample generated project to ensure tests are still passing.

  • Force push to your GitHub repository (this will update your Pull Request)

    git push -f

After your pull request is merged

After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:

  • Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:

    git push origin --delete my-fix-branch

  • Check out the master branch:

    git checkout master -f

  • Delete the local branch:

    git branch -D my-fix-branch

  • Update your master with the latest upstream version:

    git pull --ff upstream master

Development Setup

First you have to fork the generator-jhipster project and setup the development environment as detailed. Then fork the jhipster-core project and within it run npm link to create a symbolic link between the package folder and the global node modules folder. Afterwards navigate back to the cloned generator-jhipster folder and execute npm link jhipster-core.

To summarize:

  1. Fork and setup the generator-jhipster project using given instructions.
  2. Fork the jhipster-core project and run npm link within it.
  3. Navigate back to the generator-jhipster project and run npm link jhipster-core

Coding Rules

To ensure consistency throughout the source code, keep these rules in mind as you are working:

  • All features or bug fixes must be tested by one or more tests.
  • All files must follow the .editorconfig file located at the root of the JHipster generator project. Please note that generated projects use the same .editorconfig file, so that both the generator and the generated projects share the same configuration.
  • Web apps JavaScript files must follow Google's JavaScript Style Guide.

Please ensure to run yarn lint and yarn test on the project root before submitting a pull request. You can also run yarn lint-fix to fix some of the lint issues automatically.

Git Commit Guidelines

We have rules over how our git commit messages must be formatted. Please ensure to squash unnecessary commits so that your commit history is clean.

Commit Message Format

Each commit message consists of a header, a body and a footer.

<header>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.

Header

The Header contains a succinct description of the change:

  • don't capitalize the first letter
  • no dot (.) at the end

Body

If your change is simple, the Body is optional.

The Body should include the motivation for the change and contrast this with previous behavior.

Footer

The footer is the place to reference GitHub issues that this commit Closes.

You must use the GitHub keywords for automatically closing the issues referenced in your commit.

Example

For example, here is a good commit message:

upgraded to Spring Boot 1.1.7

upgraded the Maven and Gradle builds to use the new Spring Boot 1.1.7,
see http://spring.io/blog/2014/09/26/spring-boot-1-1-7-released

Fix #1234