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:

Fork the project. This creates a the project in your own Git with the default remote name 'origin'.
Clone your fork. This creates and populates a directory in your local file system.
```
 git clone https://github.com/<your-username>/jboss-eap-quickstarts.git
```
Change to the jboss-eap-quickstarts directory.
Add the remote upstream repository so you can fetch any changes to the original forked repository.
```
 git remote add upstream https://github.com/jboss-developer/jboss-eap-quickstarts.git
```
Get the latest files from the upstream repository.
```
 git fetch upstream
```
Create a new topic branch to contain your new quickstart, features, changes, or fixes using the git checkout -b <topic-branch-name> upstream/master command. If you are fixing a Bugzilla or JIRA, it is a good practice to use the number in the branch name. For new quickstarts or other fixes, try to use a good description for the branch name. For example:
```
 git checkout -b Bz-98765432 upstream/master
 git checkout -b JDF-9876543 upstream/master
 git checkout -b add-xyz-quickstart upstream/master
```
Contribute new code or make changes to existing files. Make sure that you follow the General Guidelines below.
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.
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       
```
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        
```
Commit your changes to your local topic branch.
```
git commit -m 'Description of change...'
```
Update your branch with any changes made upstream since you started.

Fetch the latest changes from upstream

git fetch upstream
Apply those changes to your branch

git rebase upstream/master
If anyone has commited changes to files that you have also changed, you may see conflicts. Resolve the conflicted files, add them using git add, and continue the rebase:

git add git rebase --continue
If there were conflicts, it is a good idea to test your changes again to make they still work.

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. 14. Browse to the branch on your forked Git repository and open a Pull Request. Give it a clear title and description.

General Guidelines

The sample project should be formatted using the JBoss AS profiles found at http://github.com/jboss/ide-config/tree/master/

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.quickstarts.<product-type>, for example: org.jboss.quickstarts.eap, org.jboss.quickstarts.wfk, org.jboss.quickstarts.jdg, org.jboss.quickstarts.brms, org.jboss.quickstarts.fuse, etc.
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 <name> in the quickstart pom.xml file should follow the template: JBoss <target-product> Quickstart: <quickstart-name> < - optional-subfolder-name> where target-product is the Target Product metadata specified in the README.md file, quickstart-name is the quickstart folder name, and optional-subfolder-name is the name of any nested subfolder containing a pom.xml file. The following are a few examples of quickstart pom files and the correct name tags:
```
  greeter/pom.xml ==> `JBoss EAP Quickstart: greeter`
  helloworld-errai/pom.xml ==> `JBoss WFK Quickstart: helloworld-errai`
  kitchensink-ear/pom.xml ==> `JBoss EAP Quickstart: kitchensink-ear`
  kitchensink-ear/ear/pom.xml --> `JBoss EAP Quickstart: kitchensink-ear - ear`
  kitchensink-ear/ejb/pom.xml ==> `JBoss EAP Quickstart: kitchensink-ear - ejb`
  kitchensink-ear/web/pom.xml ==> `JBoss EAP Quickstart: kitchensink-ear - web`
```
The <artifactId> in the quickstart pom.xml file should follow the template: jboss-<target-product>-<quickstart-name>. For example, the <artifactId> for the greeter quickstart in the EAP project is jboss-greeter. The <artifactId> for errors quickstart in the Fuse project is jboss-fuse-errors.
The JBoss developer Maven repository, which contains newly staged artifacts, is located at jboss-developer.github.io. See Configure Maven below for instructions how to configure your settings to use this repository.
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.

If the quickstart persists to a database, you must use a unique datasource JNDI name and connection URL for the application and for any Arquillian tests that it provides. Do not use the JNDI name java:jboss/datasources/ExampleDS. Failure to use unique names can result in a DuplicateServiceException when more than one quickstart is deployed to the same server.
If possible, create a cheat sheet for the quickstart to guide users and developers through the example. See the Quickstart Cheat Sheet Contributing Guide for more information.

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

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.

Install Ruby GEMs

 gem install nokogiri pygments.rb redcarpet fileutils

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
Install pygments
```
     sudo easy_install pygments
```

Configure Maven

If you are working with quickstarts currently under development in the master branch, you need access to artifacts currently under development. The JBoss developer Maven repository, which contains newly staged artifacts, is located at jboss-developer.github.io.

To access these artifacts, do one of the following:

You can simply copy the contributor-settings.xml located in the root of the quickstart directory to your ${user.home}/.m2/ and rename it to settings.xml.

Or, assuming you followed the Configure Maven instructions in the root README file, you can manually edit the settings and copy the following profile to your settings.xml file.

<profile>
    <id>jboss-developer-repository</id>
    <repositories>
        <repository>
            <id>jboss-developer-repository</id>
            <url>http://jboss-developer.github.io/temp-maven-repo/</url>
            <releases>
               <enabled>true</enabled>
            </releases>
            <snapshots>
              <enabled>false</enabled>
            </snapshots>
        </repository>
    </repositories>
    <pluginRepositories>
        <pluginRepository>
            <id>jboss-developer-plugin-repository</id>
            <url>http://jboss-developer.github.io/temp-maven-repo/</url>
            <releases>
              <enabled>true</enabled>
            </releases>
            <snapshots>
              <enabled>false</enabled>
            </snapshots>
        </pluginRepository>
    </pluginRepositories>
</profile>

Then add <activeProfile>jboss-developer-repository</activeProfile> to the <activeProfiles> section of the file.

Note: Regardless of the method you choose to configure your Maven settings, you must also delete the existing ${user.home}/.m2/repository/.

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

Quickstart Cheat Sheet Contributing Guide

Purpose of the Cheat Sheets

Cheat sheets function as a tutorial and provide a step by step guide through a quickstart.
They provide a way to step through and explain the code in an interactive way.
They can provide an in-depth analysis of specific sections of code.

Basic Steps to Create a Cheat Sheet

You can create a cheat sheet using the Eclipse Wizard or you can copy and modify an existing cheat sheet from another quickstart. This section describes how to create a cheat sheet using the Eclipse wizard.

Note: Be sure your project folder is located outside of the Eclipse workspace before you begin this process.

Import your quickstart into JBoss Developer Studio (JDBS)
1. From the menu, choose File --> Import --> Maven --> Existing Maven Projects, then click Next.
2. Navigate to your quickstart, select it, then click OK.
3. Click Finish.
Create the cheat sheet.
1. Select the imported quickstart project.
2. From the menu, choose File --> New --> Other --> User Assistance --> Cheat Sheet, then click Next.
3. Select the quickstart folder, give it a name 'cheatsheet.xml', and choose Simple Cheat Sheet.
4. Click Finish. When it prompts you to open the cheatsheet for the quickstart project, click Yes.
Populate the cheatsheet with useful information to help a user understand the quickstart.
1. Expand the Title in the content section on the left.
2. Select the Title field and modify it to something useful, for example: helloworld
3. Select the intro field and add introduction text to the Body, for example: This quickstart demonstrates the use of CDI 1.0 and Servlet 3.0. It is a simple application that can be used to verify the JBoss EAP server is configured and running correctly.
4. Select item, then under Command, click browse and select 'Get current project' under Uncategorized. This adds the following XML to the cheat sheet:
```
<command 
required="true" 
returns="currentProject"
serialization="org.jboss.tools.project.examples.cheatsheet.getProjectForCheatsheet"/>
```
This command allows you to use the variable ${currentProject} instead of a hard-coded path name and ensures your cheat sheet will work regardless of the project location.
1. Add an item for each file or class you want to describe.
  - This is dependent on the quickstart features you plan to demonstrate.
  - Provide a good description.
  - Add subitems to describe code sections and provide the line numbers that are referenced.
Test your cheat sheet by opening it in JDBS.
1. Go through each step and make sure the descriptions are valid.
2. Click on each link to make sure it opens the file and highlights the correct lines of code.
When you finish testing the cheat sheet, rename the file from cheatsheet.xml to .cheatsheet.xml and make sure it is located in the root directory of the quickstart.
Add the .cheatsheet.xml file using git add, commit the change, push it to your forked repository, and issue a pull.
If your cheat sheet is for the quickstart based on an archetype, it will automatically generate the cheat sheet for the archetype. However, you must add an <include>.cheatsheet.*</include> to the fileset for the root directory in the corresponding archetype's archetype-metadata.xml file. See the jboss-javaee6-webapp-archetype archetype for an example.

General Guidelines

If your project folder is located in the Eclipse workspace when you generate your cheat sheet using the Eclipse wizard, it will generate an invalid project name and attempts to open source code will fail. Be sure your project folder is located outside the Eclipse workspace before you begin.
The cheat sheet should be created in the root of the quickstart directory and named .cheatsheet.xml. Eclipse will not let you name the file with a leading '.', so you will need to rename it after it is created.
Make sure you add the 'Get current project' command and use the replaceable ${currentProject} value to avoid hard-coding the project path. This ensures that if the quickstart folder is moved, the cheat sheet will work as expected.
Do not use the <action> tag if it can be avoided. It is more fragile than the <command> tag, which uses parameters names instead of indexes.
Try to highlight the most important features and code for the quickstart. Pay particular attention to areas that might confuse developers. Cheat sheets require that users execute or skip each step, so you don't want to bore developers with the code that has no impact on the purpose of the quickstart.
Make sure <?xml version="1.0" encoding="UTF-8"?> is the first line in the .cheatsheet.xml file, before the license information. This enables the cheat sheet to open automatically when you import the project into JBoss Developer Studio.

Find Help

You can find additional help at the following locations:

Eclipse Help: Cheat sheets
Recommended Work Flow for Cheat Sheet Development
Max's cheat sheet example

Copy a Quickstart to Another Repository and Preserve Its History

In the source repository that currently contains the quickstarts, for example jboss-eap-quickstarts, create a branch for each quickstart you want to move. For example:
```
 git fetch upstream
 git checkout -b <source_branch_name> upstream/master
```

To extract only one quickstart, in each source branch, run:

 git filter-branch --subdirectory-filter <quickstart_name> -- --all

The previous step places the quickstart at the root of the tree. You need to create a directory using the quickstart name and move the files under it. To accomplish that task, in each source branch, run:
```
 git filter-branch --tree-filter '(ls -A; mkdir <quickstart_name>; echo <quickstart_name>) | xargs mv'
```
Push each branch up to your own GitHub repository to make merging into the destination repository easy.
```
 git push <your_remote_source_github> HEAD
```
Navigate to the target directory that does not yet contain the quickstarts, for example, jboss-sandbox-quickstarts.

Add the source GitHub repository as a remote to the local target destination repository.

 git remote add <your_remote_source_github> https://github.com/<your_remote_source_github>/jboss-eap-quickstarts.git

Create a branch, into which you will merge the quickstarts.

 git fetch upstream
 git checkout -b <target_branch_name> upstream/master

For each quickstart source branch you want to merge, run:

 git merge -s ours --no-commit <your_remote_source_github>/<source_branch_name>
 git read-tree --prefix=<quickstart_name> -u <your_remote_source_github>/<source_branch_name>
 git commit -m "Merge <quickstart_name> to XXX."

Now, rebase out the merges. Run:
```
 git rebase upstream/master
```
This should succeed with no problems as you are merging into new subdirectories.
This process leaves your GitHub repository with a lot of unwanted junk in it, so you need to do some cleaning up! Run:
```
git gc --prune=all
```

Now push this branch to your target GitHub:

git push <your_remote_target_github> HEAD

Verify that it looks correct and send a pull request.
Remove the quickstarts from the source repository if they are no longer needed.

Configure Maven on OpenShift

If your quickstart needs a Maven repository other than the standard repository configured on OpenShift, you can use the following procedure to configure Maven.

Note: The following substitution variables are used in these instructions:

CURRENT_PATH is the path where you execute the commands. For example home/jsmith/my-apps.
YOUR_APP_NAME is your application name. For example helloworld.
YOUR_ACCOUNT_NAME is your account name on OpenShift. For example jsmith.
APPLICATION_UUID is the UUID generated by OpenShift for your application. For example 52864af85973ca430200006f

When you create your OpenShift application using the rhc app create -a <app-name> -t jbosseap-6 command, you see messages similar to the following:

Your application 'YOUR_APP_NAME' is now available.

   URL:        http://YOUR_APP_NAME-YOUR_ACCOUNT_NAME.rhcloud.com/
   SSH to:     APPLICATION_UUID@YOUR_APP_NAME-YOUR_ACCOUNT_NAME.rhcloud.com
   Git remote: ssh://APPLICATION_UUID@YOUR_APP_NAME-YOUR_ACCOUNT_NAME.rhcloud.com/~/git/YOUR_APP_NAME.git/
   Cloned to:  /CURRENT_PATH/YOUR_APP_NAME

Make note of the SSH to URL that is returned. You will need that URL later to copy files to your OpenShift application.

Create a Maven settings file that contains profiles for the repositories you need to test your quickstart.

For example, if your application needs to use the temporary developer repository, you should add the following <profile> and <active-profile>:

  <profile>
      <id>jboss-developer-repository</id>
      <repositories>
          <repository>
              <id>jboss-developer-repository</id>
              <url>http://jboss-developer.github.io/temp-maven-repo/</url>
              <releases>
                 <enabled>true</enabled>
              </releases>
              <snapshots>
                <enabled>false</enabled>
              </snapshots>
          </repository>
      </repositories>
      <pluginRepositories>
          <pluginRepository>
              <id>jboss-developer-plugin-repository</id>
              <url>http://jboss-developer.github.io/temp-maven-repo/</url>
              <releases>
                <enabled>true</enabled>
              </releases>
              <snapshots>
                <enabled>false</enabled>
              </snapshots>
          </pluginRepository>
      </pluginRepositories>
  </profile>
  
  <activeProfile>jboss-developer-repository</activeProfile>

If it needs to use a local repository, you must upload the repository to OpenShift file:///${HOME}/app-root/data/ directory, and specify the URL in the settings.xml file relative to that location. You must use the ${HOME} environment variable in the URL. For example:

  <profile>
      <id>jboss-620GA-repository</id>
      <repositories>
          <repository>
              <id>jboss-620GA-repository</id>
              <url>file:///${HOME}/app-root/data/jboss-eap-6.2.0.GA-maven-repository/</url>
              <releases>
                 <enabled>true</enabled>
              </releases>
              <snapshots>
                <enabled>false</enabled>
              </snapshots>
          </repository>
      </repositories>
      <pluginRepositories>
          <pluginRepository>
              <id>jboss-620GA-repository-plugin</id>
              <url>file:///${HOME}/app-root/data/jboss-eap-6.2.0.GA-maven-repository/</url>
              <releases>
                <enabled>true</enabled>
              </releases>
              <snapshots>
                <enabled>false</enabled>
              </snapshots>
          </pluginRepository>
      </pluginRepositories>
  </profile>
  
  <activeProfile>jboss-620GA-repository</activeProfile>

Upload your settings.xml file to the OpenShift application app-root/data/ directory using the 'SSH to' URL displayed when you created the application. For example:
```
 $ scp <SETTINGS_DIRECTORY>/settings.xml APPLICATION_UUID@YOUR_APP_NAME-YOUR_ACCOUNT_NAME.rhcloud.com:app-root/data
```
If you specified a local Maven repository, upload the zip file to the OpenShift application app-root/data/ directory using the 'SSH to' URL displayed when you created the application. For example:
```
 $ scp <MAVEN_ZIP_DIRECTORY>/jboss-eap-6.2.0.CR1-maven-repository.zip  APPLICATION_UUID@YOUR_APP_NAME-YOUR_ACCOUNT_NAME.rhcloud.com:app-root/data
```
Wait until the upload completes before performing the next step. This takes a very long time!! When the upload process is complete, SSH into the same URL and unzip the Maven repository:
```
 $ ssh APPLICATION_UUID@YOUR_APP_NAME-YOUR_ACCOUNT_NAME.rhcloud.com
 cd app-root/data
 unzip jboss-eap-6.2.0.CR1-maven-repository.zip 
```
To direct Maven to use the uploaded settings.xml file, create a file in the .openshift/action_hooks/ directory named pre_build_jbosseap, containing this line:
```
 export MAVEN_ARGS="clean package -Popenshift -s ${OPENSHIFT_DATA_DIR}settings.xml -DskipTests"
```
Use git add to add the above file, along with the updated src/ and pom.xml files to GitHub.
```
 $ git add src/ pom.xml .openshift/action_hooks/pre_build_jbosseap
```
Issue the git commit and git push in the usual manner.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CONTRIBUTING.md

CONTRIBUTING.md

Quickstarts Contributing Guide

Purpose of the quickstarts

Basic Steps

General Guidelines

Kitchensink variants

Setup your environment

Configure Maven

License Information and Contributor Agreement

Java, Javascript and CSS files

HTML, XML, XSD and XHTML files

Properties files and Bash Scripts

SQL files

JSP files

Quickstart Cheat Sheet Contributing Guide

Purpose of the Cheat Sheets

Basic Steps to Create a Cheat Sheet

General Guidelines

Find Help

Copy a Quickstart to Another Repository and Preserve Its History

Configure Maven on OpenShift

Files

CONTRIBUTING.md

Latest commit

History

CONTRIBUTING.md

File metadata and controls

Quickstarts Contributing Guide

Purpose of the quickstarts

Basic Steps

General Guidelines

Kitchensink variants

Setup your environment

Configure Maven

License Information and Contributor Agreement

Java, Javascript and CSS files

HTML, XML, XSD and XHTML files

Properties files and Bash Scripts

SQL files

JSP files

Quickstart Cheat Sheet Contributing Guide

Purpose of the Cheat Sheets

Basic Steps to Create a Cheat Sheet

General Guidelines

Find Help

Copy a Quickstart to Another Repository and Preserve Its History

Configure Maven on OpenShift