First off, thank you for considering contributing to this project! Contributions of all kinds are welcome: code, documentation, bug reports, feature suggestions, and more. This document outlines the process and guidelines to help you get started.

• Code of Conduct
• How to Contribute
  • Reporting Issues
  • Feature Requests
  • Submitting Code Changes
• Setting Up Your Development Environment
• Code Guidelines
  • Code Style
  • Testing
  • Documentation
• Pull Request Process
• Community Support

This project adheres to the Code of Conduct. By participating, you agree to uphold this code. Please report unacceptable behavior to the project maintainers.

If you find a bug or have a problem using the library, please create an issue. Include as much detail as possible:

• Steps to reproduce the problem.
• Expected vs. actual behavior.
• Version of the library, Java, and any other relevant environment details.

Have an idea for a new feature? Submit a feature request and describe:

• The problem the feature solves.
• A high-level description of the proposed solution.
• Examples or use cases, if possible.

If you’re ready to contribute code, follow these steps:

1. Fork the repository.
2. Create a feature branch (git checkout -b feature/my-feature).
3. Commit your changes (git commit -m "Add my feature").
4. Push your branch (git push origin feature/my-feature).
5. Open a pull request against the main branch.

1. Clone your forked repository:

   git clone https://github.com/your-username/elearning-module-parser.git
   cd elearning-module-parser

2. Build the project:

   mvn clean compile

3. Run the tests:

   mvn test

Follow these practices:

• Use Java 17 language features where appropriate.
• Maintain consistency with the existing codebase.
• Ensure your IDE is configured to use the .editorconfig file.

• Add unit tests for new functionality.
• Ensure test coverage for edge cases.
• Use the JUnit 5 testing framework.
• Mock external dependencies using the appropriate tools (e.g., Mockito).

Run tests locally before submitting:

mvn test

• Add Javadoc for all public classes and methods.
• Update the README.md if your changes introduce new features or affect usage.

1. Ensure your changes pass all tests and adhere to the code style.
2. Provide a clear description of the changes in your pull request.
3. Reference the issue your pull request addresses (if applicable).
4. Ensure your branch is up to date with main.

Pull requests will be reviewed by the maintainers. Feedback may be provided for improvement.

If you need help or have questions, feel free to:

• Open a discussion.
• Join the conversation on relevant issues or pull requests.

Thank you for contributing to eLearning Module Parser! Your support makes this project better for everyone.