Skip to content

Latest commit

 

History

History
46 lines (29 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

46 lines (29 loc) · 2.32 KB
Raw

JBoss AS Quickstarts

Quickstarts (or examples, or samples) for JBoss AS. There are a number of rules for quickstarts:

  • Each quickstart should have a unique name, this enables a user to quickly identify each quickstart
  • A quickstart should have a simple build that the user can quickly understand. If using maven it should:
    1. Not inherit from another POM
    2. Import the various BOMs from AS7 APIs to get version numbers
    3. Use the JBoss AS Maven Plugin to deploy the example
  • The quickstart should be importable into JBoss Tools and deployable there
  • The quickstart should be explained in detail in the associated user guide, including how to deploy
  • If you add a quickstart, don't forget to update dist/src/main/assembly/README.md and pom.xml (the 'modules' section).
  • The quickstart should be formatted using the JBoss AS profiles found at https://github.com/jbossas/jboss-as/tree/master/ide-configs

You can find the documentation at https://docs.jboss.org/author/display/AS7/Documentation.

If you add a quickstart, don't forget to update dist/src/main/assembly/README.md.

The 'dist' folder contains Maven scripts to build a zip of the quickstarts.

The quickstart code is licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0.html

Quickstarts in other repositories

If your quickstarts are stored in another repository, you may wish to merge them in from there, rather than contribute them from source. If you plan to do this, discuss first with the JBoss AS Quickstarts team, as they will want to review all commits to your repo going forward.

To do this

  1. Add the other repo as a remote

    git remote add -f

  2. Merge from the tag in the other repo that you wish to use. It is important to use a tag, to make tracking of history easier. We use a recursive merge strategy, always preferring changes from the other repo, in effect overwriting what we have locally.

    git merge -s recursive -Xtheirs --no-commit

  3. The merge is not committed, so any updates to the README.md and parent POM can be made. Having made these, perform the merge. We suggest updating the commit message to "Merge ''".

    git commit

  4. Review and push to upstream

    git push upstream HEAD:master