CONTRIBUTING.md

Contributing to Apache Edge XML

Thank you for your interest in contributing to Apache Edge XML! This document provides guidelines and instructions for contributing to this project.

Code of Conduct

This project adheres to the Apache Software Foundation Code of Conduct. By participating, you are expected to uphold this code.

How to Contribute

Reporting Bugs

• Ensure the bug was not already reported by searching GitHub Issues
• If you're unable to find an open issue addressing the problem, open a new one
• Include a title and clear description, as much relevant information as possible, and a code sample or executable test case demonstrating the expected behavior that is not occurring

Suggesting Enhancements

• Open a new GitHub issue with your enhancement suggestion
• Clearly describe the enhancement and the motivation for it
• Provide examples of how the enhancement would be used

Pull Requests

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Make your changes
4. Run the tests to ensure they pass
5. Commit your changes (git commit -m 'Add some amazing feature')
6. Push to the branch (git push origin feature/amazing-feature)
7. Open a Pull Request

Code Style

• Use Swift's standard code formatting
• Follow the Swift API Design Guidelines
• Document public APIs using Swift's documentation comments

Testing

• Write tests for all new features and bug fixes
• Ensure all tests pass before submitting your contribution
• Add tests that demonstrate the bug is fixed or the feature works as expected

Development Setup

1. Clone the repository
2. Run swift package resolve to install dependencies
3. Run swift build to build the project
4. Run swift test to run tests

License

By contributing to this project, you agree that your contributions will be licensed under the project's Apache License 2.0.