Skip to content
This repository was archived by the owner on May 25, 2026. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
116 lines (73 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

116 lines (73 loc) · 2.29 KB

✨ Contributing to EmailScript

First off, thanks for checking out the project! 🙌
This app aims to detect and block temporary/disposable email addresses in real time — helping websites reduce spam, protect data, and improve user authentication.

We’d love your help in making it even better. Here’s how to get started 👇

📦 Tech Stack

  • Frontend: React (Create React App)
  • Languages: JavaScript, HTML, CSS
  • Package Manager: npm

Project Structure:


emailscript-frontend/
├── public/        # Static files
├── src/           # Main React codebase
├── package.json   # Dependencies and scripts

🛠️ Getting Started Locally

1. Fork the Repo

Click the Fork button in the top right and clone your fork locally:

git clone https://github.com/YOUR-USERNAME/emailscript-frontend.git
cd emailscript-frontend

2. Install Dependencies

npm install

3. Run the Dev Server

npm start

The app will run at http://localhost:3000 🎉

📂 Project Setup Tips

  • All React components go inside the src/ folder.
  • Static assets and metadata are in public/.
  • Keep components modular and reusable when possible.

🔧 Code Standards

  • Follow consistent naming conventions:

    • camelCase for variables and functions
    • PascalCase for React components

🚀 Submitting Changes

1. Create a New Branch

git checkout -b feature/your-feature-name

2. Commit Your Changes

git add .
git commit -m "✨ Your message here"

3. Push to Your Fork

git push origin feature/your-feature-name

4. Open a Pull Request (PR)

Make sure to:

  • Describe your changes clearly
  • Link to any related issue (if applicable)
  • Keep the PR clean and focused on one feature/fix

📣 Need Help?

Open an issue or start a discussion. No question is too small!

🙌 Thanks for contributing!

Together, we can make the web less spammy 🛡️✨ Let’s build something awesome 🚀


You can now save this as `CONTRIBUTING.md` in the root of your project and push it in your PR. Let me know if you also want a `README` badge or contributor shoutout section!