Skip to content

Latest commit

 

History

History
49 lines (31 loc) · 3.09 KB

CONTRIBUTING.md

File metadata and controls

49 lines (31 loc) · 3.09 KB
Raw

eth-phishing-detect Contributor Guidelines

Welcome to the eth-phishing-detect repository! This document outlines the guidelines and expectations for maintainers and external contributors working on this repository. The repository consists of domain lists backing the phishing-warning for MetaMask.

Please follow these guidelines to ensure a smooth collaboration process and help create a secure and effective domain management system for MetaMask.

Table of Contents

  1. Introduction
  2. Repository Structure
  3. Contribution Guidelines
  4. Communication and Support
  5. Code of Conduct

Introduction

This repository aims to manage domain lists for MetaMask, ensuring that our users have a secure and reliable experience. Maintainers are responsible for reviewing contributions, managing issues, and providing support to external contributors.

Repository Structure

The eth-phishing-detect repository is organized as follows:

  • src/: contains the source code and core logic for managing domain lists
  • src/config.json: contains the domain lists, including Fuzzy list, allow list, and block list
  • test/: contains test cases and test utilities
  • docs/: contains documentation and guidelines

Contribution Guidelines

External contributors are encouraged to contribute to the project by submitting issues, pull requests, or providing feedback on existing PRs. Please follow these steps when contributing:

  1. Fork the repository and create a new branch for your contribution.
  2. Develop your changes and ensure that they adhere to the project's coding standards and best practices. Create a pull request with a clear and concise description of your changes, including any relevant issue numbers. Engage with maintainers and other contributors to address feedback and iterate on your changes.

Communication and Support

We encourage open communication and collaboration among contributors. To facilitate this, we have set up the following channels:

  • GitHub Discussions: Use GitHub Discussions for asynchronous communication, project announcements, and general questions related to the repository.
  • GitHub Issues: Submit issues for bug reports, feature requests, or other improvements you would like to see in the project. Maintainers will provide support and guidance to external contributors through these channels.

Code of Conduct

All contributors are expected to conduct themselves in a way that promotes a welcoming and inclusive environment. Violations of our code of conduct may lead to the rejection of future contributions to this repository.

By following these guidelines, we hope to foster a collaborative and inclusive community that contributes to the ongoing improvement and security of the eth-phishing-detect repository. Thank you for your interest in contributing, and we look forward to working with you!