Skip to content

Latest commit

 

History

History
98 lines (62 loc) · 3.14 KB

CONTRIBUTING.md

File metadata and controls

98 lines (62 loc) · 3.14 KB

Contributing to starter-playwright-typescript

Thank you for considering contributing to starter-playwright-typescript! We welcome contributions from the community and appreciate your effort to help improve this project. Here’s how you can get started.

How to Contribute

Reporting Issues

If you encounter any bugs or have suggestions for improvements, please let us know by opening an issue:

  1. Go to the Issues page.
  2. Click on "New issue".
  3. Provide a clear and descriptive title for the issue.
  4. Describe the issue in detail, including steps to reproduce if applicable.
  5. Click "Submit new issue".

Suggesting Enhancements

If you have ideas for new features or improvements:

  1. Go to the Issues page.
  2. Click on "New issue".
  3. Select the "Enhancement" template if available or describe your suggestion in detail.
  4. Click "Submit new issue".

Submitting Code Changes

To contribute code, follow these steps:

  1. Fork the repository:

    Click the "Fork" button at the top right of the repository page.

  2. Clone your fork:

    git clone https://github.com/your-username/starter-playwright-typescript.git

  3. Create a new branch:

    git checkout -b my-feature-branch

    Replace my-feature-branch with a descriptive name for your branch.

  4. Make your changes:

    Implement your feature or fix the issue in this branch.

  5. Commit your changes:

    git add .
git commit -m "Describe your changes"

  6. Push your changes:

    git push origin my-feature-branch

  7. Create a Pull Request:

    • Go to the Pull Requests page.
    • Click on "New pull request".
    • Select your branch and compare it with the main branch.
    • Provide a descriptive title and detailed description of your pull request.
    • Click "Create pull request".

Code Style and Guidelines

  • Follow existing code style: Ensure that your code follows the style and conventions used in the project.
  • Write tests: Add tests for any new features or bug fixes you introduce.
  • Documentation: Update documentation if your changes affect existing functionality or introduce new features.

Code of Conduct

We are committed to creating a welcoming and inclusive community. Please follow our Code of Conduct in all interactions.

Review Process

Once you submit a pull request:

  • The project maintainers will review your changes.
  • You may be asked to make additional modifications.
  • After approval, your changes will be merged into the main branch.

Contact

If you have questions about contributing, please contact us:

Thank you for contributing to starter-playwright-typescript! Your efforts help make the project better for everyone.