JBoss Development Process Guide
Next
JBoss Development Process Guide
2004, Ivelin Ivanov, Ryan Campbell, Pushkala Iyer
2005
Table of Contents
Preface
1. Overview
1.1. Background
1.2. JEMS integration milestones
2. JBoss Issue Tracking
2.1. Creating a new Project
2.2. Creating Release Notes
2.2.1. Adding Issues to Release Notes
2.2.2. Generating Release Notes
2.3. Issues
2.3.1. Types
2.3.2. Priorities
2.3.3. Estimates and Due Dates
2.3.4. Affects Checkboxes
2.4. Managing Container Projects
2.5. Project Source Repository and Builds
2.6. Testsuites
2.7. Dependency Tracking with JIRA
3. Project Structure
4. Build System Requirements
4.1. Definitions
4.2. Goals
4.2.1. Project Decomposition
4.2.2. Dependency Management
4.2.3. Simplified Build Scripts
4.2.4. Tool Compatibility
4.3. Requirements
4.3.1. Declarative Dependencies
4.3.2. Automated Updates
4.3.3. Source Artifact Overrides
4.3.4. Dependency Version Reconciliation
4.3.5. Component Builds
4.3.6. Extensibility
4.3.7. Incremental Builds
4.3.8. Artifact JDK Version
4.3.9. Line-Precise Error Reporting
4.4. Use Cases
4.4.1. Intial Project Checkout & Build
4.4.2. Source Override
4.4.3. JBossCache Example
4.4.4. Valid Commit
4.4.5. Broken Build: Interface Changes
5. CVS Access for JBoss Sources
5.1. Obtaining a CVS Client
5.2. Anonymous CVS Access
5.3. Committer Access to CVS and JIRA
6. Coding Conventions
6.1. Templates
6.1.1. Importing Templates into the Eclipse IDE
6.2. Some more general guidelines
6.3. JavaDoc recommendations
7. Logging Conventions
7.1. Obtaining a Logger
7.2. Logging Levels
7.3. Log4j Configuration
7.3.1. Separating Application Logs
7.3.2. Specifying appenders and filters
7.3.3. Logging to a Seperate Server
7.3.4. Key JBoss Subsystem Categories
7.3.5. Redirecting Category Output
7.3.6. Using your own log4j.xml file - class loader scoping
7.3.7. Using your own log4j.properties file - class loader scoping
7.3.8. Using your own log4j.xml file - Log4j RepositorySelector
7.4. JDK java.util.logging
8. JBoss Test Suite
8.1. How To Run the JBoss Testsuite
8.1.1. Build JBoss
8.1.2. Build and Run the Testsuite
8.1.3. Running One Test at a Time
8.1.4. Clustering Tests Configuration
8.1.5. Viewing the Results
8.2. Testsuite Changes
8.2.1. Targets
8.2.2. Files
8.3. Functional Tests
8.3.1. Integration with Testsuite
8.4. Adding a test requiring a custom JBoss Configuration
8.5. Tests requiring Deployment Artifacts
8.6. JUnit for different test configurations
9. Support, Sales Force and Patch Management
9.1. An overview of the Support Process
9.2. Patch Management
9.3. Monitoring the Support Process
10. Weekly Status Reports
11. Documentation and the Documentation Process
11.1. JBoss Documentation
11.2. Producing and Maintaining Quality Documentation
11.2.1. Responsibilities
11.2.1.1. The product team
11.2.1.2. The documentation team
11.2.2. Product documentation review
11.2.3. Keep the documentation up-to-date
11.2.4. Articles and books
11.2.5. Authoring JBoss Documentation using DocBook