Contributing to Office-stamper

Setting Up the Development Environment

1. Fork the repository on GitHub
2. Clone your fork locally
3. Set up the project in your IDE
4. Build the project with Maven

git clone https://github.com/yourusername/docx-stamper.git
cd docx-stamper
mvn clean install

Project Structure

• engine/src/main/java - Core library code
• engine/src/test/java - Test code
• engine/src/test/resources - Test resources
• engine/src/site - Documentation
• cli - Command-line interface

Creating a Branch

Create a new branch for your changes:

git checkout -b feature/your-feature-name

Making Changes

1. Make your changes to the codebase
2. Add tests for your changes
3. Make sure all the tests pass
4. Update documentation if necessary

Running Tests

Run the tests to ensure your changes don’t break existing functionality:

mvn test

To keep the output files for inspection:

mvn test -DkeepOutputFile=true

Submitting a Pull Request

1. Push your changes to your fork
2. Submit a pull request to the main repository
3. Describe your changes in detail
4. Reference any related issues

Java Style Guide

Office-stamper follows a set of coding standards to ensure consistency across the codebase. Please refer to the IntelliJ style configuration for details.

Some key points:

• Use 4 spaces for indentation (not tabs)
• Follow Java naming conventions
• Add Javadoc comments for public classes and methods
• Keep methods focused and concise
• Write clear, descriptive variable and method names

Testing

• Write unit tests for all new features
• Make sure the tests are independent and repeatable
• Use meaningful test names that describe the scenario and expected outcome.
• Follow the Arrange-Act-Assert pattern

Documentation

• Update documentation for any new features or changes
• Use AsciiDoc format for documentation
• Include examples where appropriate
• Keep documentation clear and concise