Skip to content

Latest commit

 

History

History
75 lines (50 loc) · 2.65 KB

CONTRIBUTING.md

File metadata and controls

75 lines (50 loc) · 2.65 KB

Contributing to button-will-react!

First off, thank you for considering contributing to button-will-react! It's people like you who make this project fun and awesome for everyone.

This project is a collection of harmless pranks and interactive experiments. Whether you're fixing a bug, improving documentation, or adding a whole new "untouchable" button, we're excited to see what you've got!

🛠️ Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork to your local machine: 
    git clone https://github.com/iamovi/button-will-react.git
  3. Open index.html in your browser to see the main project page.

✨ Ways to Contribute

1. Adding a New "Prank" Project

Got a funny idea for a button that reacts in an unexpected way? We'd love to have it!

  • Create a new folder: Name it with the next available number (e.g., 11-your_project_name).
  • Build your prank: Use HTML, CSS, and Vanilla JavaScript. Keep it simple and dependency-free if possible.
  • Add a README: Include a small README.md (or .txt) inside your folder explaining what the prank does.
  • Update the main README: Add your project to the list in the root README.md with a description and a link to the live preview.

2. Improving Existing Projects

See a bug or a way to make a prank even more annoying (in a fun way)? Feel free to submit a fix or improvement!

3. Documentation

Help us keep our docs clean! Whether it's the main README, this guide, or individual project descriptions, every bit helps.

Project Structure

  • root/: Main entry point (index.html) and global assets/.
  • [number]-[name]/: Individual sub-projects (e.g., 1-signin, 2-propose). Each contains its own index.html and logic.

Code Style Guidelines

  • Keep it simple: Vanilla HTML, CSS, and JavaScript are preferred to keep the repo lightweight.
  • Be Descriptive: Use clear comments in your code.
  • No Malicious Code: This project is for fun and education only. Any harmful code will be immediately rejected.

Submitting a Pull Request

  1. Create a new branch for your feature or fix: 
    git checkout -b feature/cool-new-prank
  2. Commit your changes with a descriptive message.
  3. Push your branch to your fork: 
    git push origin feature/cool-new-prank
  4. Open a Pull Request on the main repository.

Contact me if you have any questions or get stuck:

init.ovi@gmail.com

💬 Questions?

If you're unsure about anything, feel free to open an Issue or reach out!

Happy coding and have fun pranking! 💖