Contributing Guide

Welcome

Thank you for contributing to @drupal/dita-ccms!

Code of Conduct

{{CODE_OF_CONDUCT}}

Getting Started

1. Fork the repository
2. Clone your fork
3. Create a feature branch
4. Make your changes
5. Submit a merge request

Development Setup

See Development Guide for detailed setup instructions.

Contribution Workflow

1. Find or Create an Issue

• Check existing issues
• Create new issue if needed
• Get issue assigned to you

2. Create Feature Branch

git checkout -b feature/issue-123-description development

3. Make Changes

• Write code
• Add tests
• Update documentation
• Follow code style

4. Commit Changes

git add .
git commit -m "feat(scope): description

Closes #123"

5. Push and Create MR

git push origin feature/issue-123-description

Create merge request with: - Clear title - Description of changes - Link to issue - Screenshots (if UI changes)

Code Standards

Style Guide

{{STYLE_GUIDE}}

Testing Requirements

• Unit tests for new functions
• Integration tests for APIs
• E2E tests for user flows
• Minimum 80% coverage

Documentation Requirements

• JSDoc/TSDoc for public APIs
• README updates for new features
• Wiki updates for architecture changes
• OpenAPI spec updates for API changes

Review Process

Merge Request Checklist

• [ ] Tests pass
• [ ] Linting passes
• [ ] Documentation updated
• [ ] No breaking changes (or documented)
• [ ] Reviewed by maintainer

Review Guidelines

{{REVIEW_GUIDELINES}}

Types of Contributions

Bug Fixes

1. Create issue describing bug
2. Write failing test
3. Fix bug
4. Verify test passes

New Features

1. Discuss in issue first
2. Get approval from maintainers
3. Implement with tests
4. Update documentation

Documentation

• Fix typos
• Improve clarity
• Add examples
• Update outdated info

Performance Improvements

• Include benchmarks
• Document improvements
• Add performance tests

Community

Communication Channels

{{COMMUNICATION_CHANNELS}}

Getting Help

{{HELP_RESOURCES}}

Recognition

Contributors are recognized in: - CHANGELOG.md - Contributors page - Release notes

License

By contributing, you agree that your contributions will be licensed under MIT.