Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
110 lines (77 loc) · 3.81 KB

CONTRIBUTING.md

File metadata and controls

110 lines (77 loc) · 3.81 KB

Contributing to Vibe Coder Test Automation Repository

Thank you for your interest in contributing to the Vibe Coder Test Automation Repository! This guide explains how you can contribute to this project and help improve test automation practices for the community.

Ways to Contribute

There are many ways you can contribute to this repository:

  1. Add new test examples: Create new test examples for frameworks or technologies not yet covered
  2. Improve existing examples: Enhance existing test examples with better practices or more features
  3. Update documentation: Improve guides, READMEs, or comments in code
  4. Fix bugs: Help fix issues in existing test examples or scripts
  5. Add new tooling: Contribute integration examples with additional CI/CD platforms or testing tools
  6. Share best practices: Contribute your knowledge about test automation best practices
  7. Report issues: Report bugs or suggest improvements through GitHub issues

Getting Started

Prerequisites

  • Basic understanding of Git and GitHub
  • Experience with at least one test automation framework
  • Familiarity with the programming language used in your contribution

Setup

  1. Fork the repository to your own GitHub account
  2. Clone the repository to your local machine: 
    git clone https://github.com/YOUR-USERNAME/vibe-coder-test-automation.git
  3. Create a new branch for your changes: 
    git checkout -b feature/your-feature-name

Contribution Guidelines

Adding New Examples

When adding new test examples:

  1. Follow the existing directory structure
  2. Include comprehensive comments in your code
  3. Create or update relevant README files explaining your example
  4. Ensure all examples are working and can be run by following your instructions
  5. Add any necessary dependencies to appropriate package files

Code Style

  • Follow the code style used in the existing examples
  • Use meaningful variable and function names
  • Include comments for complex logic
  • Write clean, readable, and maintainable code

Documentation

  • Use clear and concise language
  • Include step-by-step instructions where applicable
  • Add screenshots or diagrams when they help explain concepts
  • Link to external resources when appropriate

Commit Messages

  • Use clear and descriptive commit messages
  • Reference issue numbers when applicable
  • Use present tense ("Add feature" not "Added feature")
  • Keep the first line under 72 characters

Example:

Add Playwright mobile testing example

- Add mobile viewport tests for authentication flow
- Include responsive design testing strategies
- Update documentation with mobile testing best practices

Fixes #42

Pull Request Process

  1. Update your fork with the latest changes from the main repository
  2. Push your changes to your fork on GitHub
  3. Create a pull request from your branch to the main repository
  4. Fill out the pull request template with details about your changes
  5. Wait for a maintainer to review your pull request
  6. Address any feedback or requested changes
  7. Once approved, your changes will be merged into the main branch

Code of Conduct

Please note that this project follows a Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to the repository maintainers.

Our Standards

  • Be respectful and inclusive
  • Focus on constructive feedback
  • Be patient and welcoming to newcomers
  • Value diverse perspectives and experiences

Recognition

Contributors will be acknowledged in the repository's README. Significant contributions may earn you a place in the core contributors list.

Questions?

If you have any questions about contributing, feel free to open an issue with your question or contact the repository maintainers directly.

Thank you for contributing to better test automation practices!