Skip to content

Latest commit

 

History

History
260 lines (176 loc) · 13.1 KB

CONTRIBUTING.md

File metadata and controls

260 lines (176 loc) · 13.1 KB
Raw

Quickstarts Contributing Guide

Purpose of the quickstarts

  • To demonstrate Java EE 6 technologies

  • To provide developers with working examples and instructions that are easy to follow .

  • To allow examples to be copied by developers and used as the basis for their own projects.

Basic Steps

To contribute to the quickstarts, fork the quickstart 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 with the default remote name 'origin'.

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

     git clone git@github.com:<your-username>/jboss-as-quickstart.git

  3. Add the remote upstream repository so you can fetch any changes to the original forked repository.

     git remote add upstream git@github.com:jboss-jdf/jboss-as-quickstart.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 using the git checkout -b <topic-branch-name> upstream/master command. For example:

     git checkout -b helloworld-fix upstream/master

  6. Contribute new code or make changes to existing files. Make sure that you follow the General Guidelines below.

  7. To verify if your code followed the General Guidelines you can run QS Tools on your project.

    • To run QS Tools, go to your quickstart project root and execute:

        mvn -U org.jboss.maven.plugins:maven-qstools-plugin:check

    This will generate a report on QUICKSTART_HOME/target/site/qschecker.html. Review the report to determine if your quickstart project violates any item in the General Guidelines.

  8. Use the git add command to add new or changed file contents to the staging area.

    • If you create a new quickstart, you can add files using the subfolder and file names. The following is an example of new quickstart folders and files you may want to stage:

         git add src/
   git add pom.xml
   git add README.md

    Note: It is probably best not to add the entire quickstart root folder because you may unintentionally add classes or other target files that should not be in source control.

    • If you only modified a few files, use git add <filename> for every file you create or change. For example:

         git add README.md

  9. Use the git status command to view the status of the files in the directory and in the staging area and ensure that all modified files are properly staged:

     git status

  10. Commit your changes to your local topic branch.

    git commit -m 'Description of change...'

  11. 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

Note: The above command assumes your remote repository is named 'origin'. You can verify your forked remote repository name using the command git remote -v. 12. Browse to the branch on your forked Git repository and open a Pull Request. Give it a clear title and description.

General Guidelines

  • Code should be well documented with good comments. Please add an author tag (@author) to credit yourself for writing the code.
  • You should use readable variable names to make it easy for users to read the code.

  • The package must be org.jboss.as.quickstarts

  • The quickstart project or folder name should match the quickstart name. Each sample project should have a unique name, allowing easy identification by users and developers.

  • The quickstart project <artifactId> in the pom.xml file must be prefixed by jboss-as-. For example, the <artifactId> for the greeter quickstart is jboss-as-greeter.

  • If you create a quickstart that uses a database table, make sure the name you use for the table is unique across all quickstarts.

  • The project must follow the structure used by existing quickstarts such as numberguess. A good starting point would be to copy the numberguess project.

  • The sample project should be importable into JBoss Developer Studio/JBoss Tools and be deployable from there.

  • Maven POMs must be used. No other build system is allowed unless the purpose of the quickstart is to show another build system in use. If using Maven it should:

  • Not inherit from another POM
  • Maven POMs must use the Java EE spec BOM/POM imports
  • The POMs must be commented, with a comment each item in the POM
  • Import the various BOMs, either directly from a project, or from JBoss BOMs, to determine version numbers. You should aim to have no dependencies declared directly. If you do, work with the jdf team to get them added to a BOM.
  • Use the JBoss AS Maven Plugin to deploy the example

  • The sample project must contain a README.md file using the template/README.md file as a guideline

  • Don't forget to update the pom.xml in the quickstart root directory. Add your quickstart to the 'modules' section.

  • The project must target Java 6

  • CDI should be used as the programming model
  • Avoid using a web.xml if possible. Use faces-config.xml to activate JSF if needed.
  • Any tests should use Arquillian.

Kitchensink variants

There are multiple quickstarts based on the kitchensink example. Each showcases different technologies and techniques including pure EE6, JSF, HTML5, and GWT.

If you wish to contribute a kitchensink variant is it important that you follow the look and feel of the original so that useful comparisons can be made. This does not mean that variants can not expand, and showcase additional functionality. Multiple variants already do that. These include mobile interfaces, push updates, and more.

Below are rules for the look and feel of the variants:

  • Follow the primary layout, style, and graphics of the original.

  • Projects can have 3-4 lines directly under the AS/EAP banner in the middle section to describe what makes this variant different.

    • How projects use that space is up to them, but options include plain text, bullet points, etc....

  • Projects can have their logo in the left side of the banner.

    • The sidebar area can contain a section with links to the related projects, wiki, tutorials, etc...
      • This should be below any AS/EAP link areas.

    If appropriate for the technology the application should expose RESTful endpoints following the example of the original kitchensink quickstart. This should also include the RESTful links in the member table.

Setup your environment

The quickstart README.md files are converted to HTML using markdown. We recommend using redcarpet, as that is what github uses, but you can use any markdown tool really.

There are two scripts, dist/github-flaoured-markdown.rb, that will convert an indivdual file, and dist/release-utils.sh -m, that will convert all the files.

To setup the environment you need to follow these steps.

  1. Install Ruby 1.9.X

    For RHEL you can use this spec

    In general, you're better off not relying on your OSs ruby install, they are often quite broken.

  2. Install Ruby GEMs

     gem install nokogiri pygments.rb redcarpet fileutils

  3. Install Python Eggs

    You'll need python eggs installed, which often isn't available on OS installs of python. Google to find out how to install it

  4. Install pygments

         sudo easy_install pygments

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, Javascript and CSS files

  /** 
   * JBoss, Home of Professional Open Source
   * Copyright 2013, 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.
   */

HTML, XML, XSD and XHTML files

  <!--
   JBoss, Home of Professional Open Source
   Copyright 2013, 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.
   -->

Properties files and Bash Scripts

   # JBoss, Home of Professional Open Source
   # Copyright 2013, 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.

SQL files

  --
  -- JBoss, Home of Professional Open Source
  -- Copyright 2013, 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.
  --

JSP files

  <%--
  JBoss, Home of Professional Open Source
  Copyright 2013, 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.
  --%>