Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (38 loc) · 2.17 KB

CONTRIBUTING.md

File metadata and controls

54 lines (38 loc) · 2.17 KB

Contributing to Email Vulnerability Checker

First off, thanks for taking the time to contribute! 🎉 The following is a set of guidelines for contributing to Email Vulnerability Checker, hosted on GitHub.

How Can I Contribute?

Reporting Bugs

If you find a bug in the project, please report it by following these steps:

  1. Check if the issue has already been reported.
  2. Open a new issue if it hasn't been reported.
  3. Include detailed information about the bug, including steps to reproduce, expected behavior, and any relevant screenshots or logs.

Suggesting Enhancements

If you have an idea to improve the project, please suggest it by:

  1. Opening a new issue.
  2. Providing a clear and detailed description of the proposed enhancement.
  3. Explaining why the enhancement would be beneficial.

Submitting Pull Requests

If you want to fix a bug or implement a new feature:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature-name).
  3. Make your changes.
  4. Ensure your code adheres to the project's coding standards.
  5. Write tests for your changes, if applicable.
  6. Commit your changes (git commit -am 'Add new feature').
  7. Push to the branch (git push origin feature-name).
  8. Open a Pull Request.

Coding Standards

To maintain code quality and consistency, please follow these guidelines:

  • Use clear and descriptive commit messages.
  • Write meaningful comments in your code.
  • Follow the project's coding style and conventions.
  • Ensure your code passes all tests and linting checks.

Development Environment Setup

To set up the development environment:

  1. Clone the repository (git clone https://github.com/your-username/your-repo.git).
  2. Install dependencies using the package manager specified in the project (e.g., npm install for Node.js projects).
  3. Follow any additional setup instructions provided in the README.md.

Code of Conduct

This project adheres to a Code of Conduct. By participating, you are expected to uphold this code. Please report any unacceptable behavior to sayedalirizvi001@gmail.com.

Thank you for contributing to Email Vulnerability Checker! Together, we can make this project better for everyone. Happy coding!