Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
75 lines (56 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

75 lines (56 loc) · 1.68 KB

Contributing to Cypress Gmail API Testing

Thank you for your interest in contributing! This project welcomes contributions from the community.

How to Contribute

1. Fork the Repository

Click the "Fork" button on GitHub to create your own copy of the project.

2. Clone Your Fork

git clone https://github.com/YOUR_USERNAME/cypress-gmail-api-testing.git
cd cypress-gmail-api-testing

3. Create a Feature Branch

git checkout -b feature/your-feature-name

4. Make Your Changes

  • Write clear, descriptive commit messages
  • Follow TypeScript best practices
  • Add tests for new functionality
  • Update documentation if needed

5. Test Your Changes

npm run test

6. Push to Your Fork

git push origin feature/your-feature-name

7. Open a Pull Request

  • Provide a clear PR title and description
  • Reference any related issues
  • Wait for code review

Code Standards

TypeScript

  • Use strict mode (strict: true in tsconfig.json)
  • Add type annotations for all functions
  • Use descriptive variable names

Cypress Tests

  • Write clear test descriptions
  • Use meaningful assertions
  • Keep tests focused and isolated
  • Add comments for complex logic

Documentation

  • Update README.md if adding new features
  • Include code examples
  • Document any new environment variables

Issue Reporting

When reporting bugs, please include:

  • Steps to reproduce
  • Expected behavior
  • Actual behavior
  • OS and Node.js version
  • Error messages or logs

Questions?

Open an issue on GitHub with your question, and we'll help!

Thank you for contributing! 🙏