From 2f534e999a20827ed2182527912e3a22a8b2cb34 Mon Sep 17 00:00:00 2001 From: Rafael Benevides Date: Fri, 4 Jan 2013 13:00:06 -0200 Subject: [PATCH] Added Contributing guide and removed use cases from readme --- CONTRIBUTING.md | 50 +++++++++++++++++++++++++++++++++++++++++++++---- README.md | 36 ----------------------------------- 2 files changed, 46 insertions(+), 40 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4e9b8832..7a977b97 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,48 @@ -JBoss BOMs -==================== +JBoss BOMs Contributing Guide +============================= -BOMs. There are a number of rules for BOMs: +BOM's 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 with BOMs, clone your own fork instead of cloning the main BOMs repository, commit your work on topic branches and make pull requests. In detail: + +1. [Fork](http://help.github.com/fork-a-repo/) the project. + +2. Clone your fork (`git@github.com:/jboss-bom.git`). + +3. Add an `upstream` remote (`git remote add upstream git@github.com:jboss-jdf/jboss-bom.git`). + +4. Get the latest changes from upstream (e.g. `git pull upstream master`). + +5. Create a new topic branch to contain your feature, change, or fix (`git checkout -b `). + +6. Make sure that your changes follow the General Guide Lines. + +7. Commit your changes to your topic branch. + +8. Push your topic branch up to your fork (`git push origin `). + +9. [Open a Pull Request](http://help.github.com/send-pull-requests/) with a clear title and description. + +If you don't have the Git client (`git`), get it from: + +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](http://www.jboss.org/jdf/forums/jdf-dev/) 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 -TODO diff --git a/README.md b/README.md index 9caf11a9..352c4e69 100644 --- a/README.md +++ b/README.md @@ -41,39 +41,3 @@ Unfortunately, Maven doesn't allow you to specify plugin versions this way. The You'll need to take a look at the POM source in order to find the latest versions of plugins recommended. -Use cases ---------- - -A number of BOMs are provided, each of which address a specific use case. If your usage falls into a number of use cases, simply use all of the relevant BOMs. - -### jboss-javaee-6.0-with-errai: Java EE with Errai and GWT - -Errai provides a comprehensive framework and tools for building rich web applications, leveraging the GWT compiler. With standard server-side APIs, such as CDI, in the browser, managing large web applications was never so easy. This BOM adds both Errai and GWT to your project. - -[Read more](jboss-javaee-6.0-with-errai/README.md) - -### jboss-javaee-6.0-with-hibernate: Java EE with Hibernate - -Historically, Hibernate facilitated the storage and retrieval of Java domain objects via Object/Relational Mapping. Today, Hibernate is a collection of related projects enabling developers to utilize POJO-style domain models in their applications in ways extending well beyond Object/Relational Mapping. - -This BOM builds on the Java EE full profile BOM, adding Hibernate Community projects including Hibernate ORM, Hibernate Search and Hibernate Validator. It also provides tool projects such as Hibernate JPA Model Gen and Hibernate Validator Annotation Processor. - -[Read more](jboss-javaee-6.0-with-hibernate/README.md) - -### jboss-javaee-6.0-with-tools: Java EE with tools recommended by JBoss - -Java EE lacks any testing APIs, and for this reason JBoss developed the Arquillian project, along with it's various component projects, such as Arquillian Drone, and the sister project Shrinkwrap. This BOM builds on the Java EE full profile BOM, adding Arquillian to the mix. It also provides a version of JUnit and TestNG recommended for use with Arquillian. - -Furthermore, this BOM adds the JBoss AS Maven deployment plugin. EAP 6's recommended mode of deployment is via the management APIs, and the Maven plugin is the recommended way to do this, if the customer is using Maven for building. - -[Read more](jboss-javaee-6.0-with-tools/README.md) - -### jboss-javaee-6.0-with-transactions: Java EE with JBoss Transactionss - - -JBoss AS includes a world class transaction manager. In order to access it's full capabilites, including for example XTS, WS-AT and WS-BA, you need to use the JBossTS APIs. - -This BOM adds the JBossTS APIs to the stack. - -[Read more](jboss-javaee-6.0-with-transactions/README.md) -