Search

Get Involved with JBoss Stacks


Found a bug? Think there is something missing? Then you probably want to report an issue.

Coding has become social! Fork us!

Don't forget to read the Contributing Guide below

NoteThis Contributing Guide was generated from https://raw.github.com/jboss-jdf/jboss-bom/master/CONTRIBUTING.md


JBoss BOMs Contributing Guide

BOMs are Maven pom.xml files that specify the versions of all runtime dependencies for a given module. So by importing this BOM, you are specifying the versions of the dependencies required to use the specified stack.

Basic Steps

To contribute to the JBoss BOMs, fork the JBoss BOMs repository to your own Git, clone your fork, commit your work on topic branches, and make pull requests.

If you don't have the Git client (git), get it from: http://git-scm.com/

Here are the steps in detail:

  1. Fork the project. This creates a the project in your own Git.

  2. Clone your fork. This creates a directory in your local file system.

    git clone git@github.com:<your-username>/jboss-bom.git
    
  3. Add the remote upstream repository.

    git remote add upstream git@github.com:jboss-jdf/jboss-bom.git
    
  4. Get the latest files from the upstream repository.

    git fetch upstream
    
  5. Create a new topic branch to contain your features, changes, or fixes.

    git checkout -b <topic-branch-name> upstream/master
    
  6. Contribute new code or make changes to existing files. Make sure that you follow the General Guidelines below.

  7. Commit your changes to your local topic branch. You must use git add filename for every file you create or change.

    git add <changed-filename>
    git commit -m `Description of change...`
    
  8. Test your changes.

    • Install a SNAPSHOT version to your LOCAL Maven repository by typing the following command:

      mvn clean install 
      
    • Modify the quickstart POM file to include the new BOM.

      • Add a property variable to the <properties> section of the POM file and specify the locally installed SNAPSHOT version of the BOM.
      • Add the new BOM to the <dependencyManagement> section of the POM. Use the property variable name defined in the previous step to specify the version.
    • Build, deploy, and test your quickstart using the -U parameter to force a check for snapshots. For example:

      mvn -U clean package jboss-as:deploy
      
  9. Push your local topic branch to your github forked repository. This will create a branch on your Git fork repository with the same name as your local topic branch name.

    git push origin HEAD            
    
  10. Browse to the branch on your forked Git repository and open a Pull Request. Give it a clear title and description.

General Guidelines

  • It can be tricky to work out when to add a new stack, rather than extend an existing stack. We strongly encourage you to discuss your planned BOM on the dev list before starting.

  • Each BOM is a child module of the parent BOM module. Copy an existing module as a template. Remember to give it a unique, and descriptive name. You should follow the conventions defined by the existing BOMs when naming it. All BOMs live in the same repository.

  • Most BOMs build on the base Java EE stack, and as such, import it. This is reflected in the name of the BOM "jboss-javaee6-with-XXX".

  • All dependencies versions should references properties that is declared on root pom.xml

  • The BOM should contain a README.md file, explaining:

    • What the stack described by the BOM includes
    • An example of its usage
    • Any notes about plugins included in the stack
  • The BOM should be formatted using the JBoss AS profiles found at https://github.com/jboss/ide-configs/tree/master/ide-configs

NoteThis Contributing Guide was generated from https://raw.github.com/jboss-jdf/jboss-as-archetype/master/CONTRIBUTING.md


JBoss Archetypes Contributing Guide

Archetype is a Maven project templating toolkit

Basic Steps

To contribute to the Archetypes, fork the Archetypes repository to your own Git, clone your fork, commit your work on topic branches, and make pull requests.

If you don't have the Git client (git), get it from: http://git-scm.com/

Here are the steps in detail:

  1. Fork the project. This creates a the project in your own Git.

  2. Clone your fork. This creates a directory in your local file system.

    git clone git@github.com:<your-username>/jboss-as-archetype.git
    
  3. Add the remote upstream repository.

    git remote add upstream git@github.com:jboss-jdf/jboss-as-archetype.git
    
  4. Get the latest files from the upstream repository.

    git fetch upstream
    
  5. Create a new topic branch to contain your features, changes, or fixes.

    git checkout -b <topic-branch-name> upstream/master
    
  6. Contribute new code or make changes to existing files. Make sure that you follow the General Guidelines below.

  7. Commit your changes to your local topic branch. You must use git add filename for every file you create or change.

    git add <changed-filename>
    git commit -m `Description of change...`
    
  8. Push your local topic branch to your github forked repository. This will create a branch on your Git fork repository with the same name as your local topic branch name.

    git push origin HEAD            
    
  9. Browse to the branch on your forked Git repository and open a Pull Request. Give it a clear title and description.

General Guidelines

License Information and Contributor Agreement

JBoss Developer Framework is licensed under the Apache License 2.0, as we believe it is one of the most permissive Open Source license. This allows developers to easily make use of the code samples in JBoss Developer Framework.

There is no need to sign a contributor agreement to contribute to JBoss Developer Framework. You just need to explicitly license any contribution under the AL 2.0. If you add any new files to JBoss Developer Framework, make sure to add the correct header.

Java

  /*
   * JBoss, Home of Professional Open Source
   * Copyright <Year>, Red Hat, Inc. and/or its affiliates, and individual
   * contributors by the @authors tag. See the copyright.txt in the 
   * distribution for a full listing of individual contributors.
   *
   * Licensed under the Apache License, Version 2.0 (the "License");
   * you may not use this file except in compliance with the License.
   * You may obtain a copy of the License at
   * http://www.apache.org/licenses/LICENSE-2.0
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,  
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */

XML

  

Properties files

   # JBoss, Home of Professional Open Source
   # Copyright 2012, Red Hat, Inc. and/or its affiliates, and individual
   # contributors by the @authors tag. See the copyright.txt in the 
   # distribution for a full listing of individual contributors.
   #
   # Licensed under the Apache License, Version 2.0 (the "License");
   # you may not use this file except in compliance with the License.
   # You may obtain a copy of the License at
   # http://www.apache.org/licenses/LICENSE-2.0
   # Unless required by applicable law or agreed to in writing, software
   # distributed under the License is distributed on an "AS IS" BASIS,  
   # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   # See the License for the specific language governing permissions and
   # limitations under the License.

NoteThis Contributing Guide was generated from https://raw.github.com/jboss-jdf/jdf-stack/1.0.0.Final/CONTRIBUTING.md


jdf-stack Contributing Guide

Basic Steps

To contribute to the jdf-stack, fork the jdf-stack repository to your own Git, clone your fork, commit your work on topic branches, and make pull requests.

If you don't have the Git client (git), get it from: http://git-scm.com/

Here are the steps in detail:

  1. Fork the project. This creates a the project in your own Git.

  2. Clone your fork. This creates a directory in your local file system.

    git clone git@github.com:<your-username>/jdf-stack.git
    
  3. Add the remote upstream repository.

    git remote add upstream git@github.com:jboss-jdf/jdf-stack.git
    
  4. Get the latest files from the upstream repository.

    git fetch upstream
    
  5. Create a new topic branch to contain your features, changes, or fixes.

    git checkout -b <topic-branch-name> upstream/master
    
  6. Contribute new code or make changes to existing files. Make sure that you follow the General Guidelines below.

  7. Run the tests to check that everything is ok.

    mvn test
    mvn test -DskipArchetypeBuildTests #If you wish to skip the archetypes test
    
  8. Commit your changes to your local topic branch. You must use git add filename for every file you create or change.

    git add <changed-filename>
    git commit -m `Description of change...`
    
  9. Push your local topic branch to your github forked repository. This will create a branch on your Git fork repository with the same name as your local topic branch name.

    git push origin HEAD            
    
  10. Browse to the branch on your forked Git repository and open a Pull Request. Give it a clear title and description.

General Guidelines

  • The current file format is 1.0.0

  • The id of each item must match its anchor (&)

  • The recommendedVersion attribute of Archetypes and BOMs must have it's correspondent ArchetypeVersion and BOMVersion

  • The artifact (Archetype, BOM or Runtime) must be released before sending the pull request

  • The pull request must be sent to the 1.0.0 branch

File format evolution

This file has a strict file format defined by the Stacks format diagram

Each branch represents a file format. If you need to alter the file format, we strongly encourage you to discuss your planned change on the dev list before starting.

If you need to update the stacks.yaml format, create a new branch to to avoid breaking compatibility with previous format versions.

NoteThis Contributing Guide was generated from https://raw.github.com/jboss-jdf/jdf-stacks-client/master/CONTRIBUTING.md


jdf-stacks-client Contributing Guide

Basic Steps

To contribute to the jdf-stacks-client, fork the jdf-stacks-client repository to your own Git, clone your fork, commit your work on topic branches, and make pull requests.

If you don't have the Git client (git), get it from: http://git-scm.com/

Here are the steps in detail:

  1. Fork the project. This creates a the project in your own Git.

  2. Clone your fork. This creates a directory in your local file system.

    git clone git@github.com:<your-username>/jdf-stacks-client.git
    
  3. Add the remote upstream repository.

    git remote add upstream git@github.com:jboss-jdf/jdf-stacks-client.git
    
  4. Get the latest files from the upstream repository.

    git fetch upstream
    
  5. Create a new topic branch to contain your features, changes, or fixes.

    git checkout -b <topic-branch-name> upstream/master
    
  6. Contribute new code or make changes to existing files.

  7. Commit your changes to your local topic branch. You must use git add filename for every file you create or change.

    git add <changed-filename>
    git commit -m `Description of change...`
    
  8. Push your local topic branch to your github forked repository. This will create a branch on your Git fork repository with the same name as your local topic branch name.

    git push origin HEAD            
    
  9. Browse to the branch on your forked Git repository and open a Pull Request. Give it a clear title and description.

NoteThis Contributing Guide was generated from https://raw.github.com/jboss-jdf/plugin-jdf/master/CONTRIBUTING.md


plugin-jdf Contributing Guide

Basic Steps

To contribute to the plugin-jdf, fork the plugin-jdf repository to your own Git, clone your fork, commit your work on topic branches, and make pull requests.

If you don't have the Git client (git), get it from: http://git-scm.com/

Here are the steps in detail:

  1. Fork the project. This creates a the project in your own Git.

  2. Clone your fork. This creates a directory in your local file system.

    git clone git@github.com:<your-username>/plugin-jdf.git
    
  3. Add the remote upstream repository.

    git remote add upstream git@github.com:jboss-jdf/plugin-jdf.git
    
  4. Get the latest files from the upstream repository.

    git fetch upstream
    
  5. Create a new topic branch to contain your features, changes, or fixes.

    git checkout -b <topic-branch-name> upstream/master
    
  6. Contribute new code or make changes to existing files. Make sure that you follow the General Guidelines below.

  7. Commit your changes to your local topic branch. You must use git add filename for every file you create or change.

    git add <changed-filename>
    git commit -m `Description of change...`
    
  8. Push your local topic branch to your github forked repository. This will create a branch on your Git fork repository with the same name as your local topic branch name.

    git push origin HEAD            
    
  9. Browse to the branch on your forked Git repository and open a Pull Request. Give it a clear title and description.