Contributing

How to Contribute

We welcome contributions to the Playwright Java Framework! Here's how you can help:

Reporting Issues

Found a bug or have a feature request? Open an issue on GitHub:

1. Go to the Issues page
2. Click "New Issue"
3. Choose the appropriate issue type (Bug, Feature Request, etc.)
4. Provide detailed information:
   • Description of the issue or feature
   • Steps to reproduce (for bugs)
   • Expected vs. actual behavior
   • Environment details (Java version, OS, etc.)

Submitting Pull Requests

Want to contribute code? Follow these steps:

1. Fork the repository
   • Click the "Fork" button on GitHub
   • Clone your fork locally:

     git clone https://github.com/your-username/playwright-java-framework.git
     cd playwright-java-framework

2. Create a branch

   git checkout -b feature/your-feature-name
   # or
   git checkout -b fix/your-bug-fix

3. Make your changes
   • Write clean, well-documented code
   • Follow existing code style and conventions
   • Add tests for new features
   • Update documentation if needed
4. Test your changes

   mvn clean test

5. Commit your changes

   git add .
   git commit -m "Description of your changes"

6. Push to your fork

   git push origin feature/your-feature-name

7. Create a Pull Request
   • Go to the original repository on GitHub
   • Click "New Pull Request"
   • Select your fork and branch
   • Fill out the PR template with details about your changes

Code Style Guidelines

• Follow Java naming conventions
• Use meaningful variable and method names
• Add comments for complex logic
• Keep methods focused and single-purpose
• Write self-documenting code when possible

Test Requirements

All contributions should include tests:

• New features should have corresponding test scenarios
• Bug fixes should include tests that verify the fix
• Ensure all existing tests still pass
• Follow BDD principles with Gherkin feature files

Documentation

Keep documentation up to date:

• Update README.md for significant changes
• Add code comments for public APIs
• Update this documentation site if needed
• Include examples in your contributions

What to Contribute

We welcome contributions in these areas:

• Bug fixes - Fix issues reported in GitHub
• New features - Add functionality that enhances the framework
• Documentation - Improve guides, examples, and API docs
• Test coverage - Add tests for existing features
• Performance - Optimise existing code
• Examples - Add example feature files and step definitions

Questions?

If you have questions about contributing:

• Open a discussion on GitHub
• Check existing issues and pull requests
• Review the codebase to understand patterns