Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
119 lines (72 loc) · 2.8 KB

CONTRIBUTING.md

File metadata and controls

119 lines (72 loc) · 2.8 KB

🤝 Contributing to GitHub Pattern Generator

First of all, thank you for taking the time to contribute! ❤️
This project exists because of the open-source community, and all kinds of contributions are welcome.

Whether you’re here to improve the UI, add animations, optimize logic, or fix a small bug — you’re awesome.

🌟 Ways You Can Contribute

You can help this project in many ways:

🎨 Design & UI/UX Improvements

  • Improve button styles, layout, or spacing
  • Add smooth animations or transitions
  • Enhance responsiveness for mobile/tablet
  • Improve color contrast or accessibility

🧠 Logic & Functionality

  • Optimize grid interaction logic
  • Improve pattern export (pattern.json) structure
  • Add new features or configuration options
  • Improve performance or code readability

🐛 Bug Fixes

  • Fix UI glitches or unexpected behavior
  • Handle edge cases in pattern drawing/export
  • Improve error handling

📖 Documentation

  • Improve README or add examples
  • Fix typos or unclear explanations
  • Add comments to the code for clarity

🛠️ Getting Started

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/github-pattern-generator.git

3️⃣ Create a New Branch

git checkout -b feature/your-feature-name

Use clear branch names like:

  • ui/button-animation
  • fix/export-bug
  • feature/grid-enhancement

💻 Development Guidelines

  • Keep the project framework-free (HTML, CSS, JavaScript only)
  • Write clean, readable code
  • Follow existing code style
  • Avoid unnecessary dependencies
  • Test your changes in the browser before submitting

✅ Commit Message Guidelines

Use simple and meaningful commit messages:

  • feat: add hover animation to buttons
  • fix: resolve export json bug
  • ui: improve grid responsiveness
  • docs: update README usage section

📤 Submitting a Pull Request

  1. Push your changes to your fork
  2. Open a Pull Request to the main branch
  3. Clearly describe:
    • What you changed
    • Why the change is needed
    • Any screenshots or GIFs (for UI changes)

Your PR will be reviewed as soon as possible 🚀

🧪 Testing

  • Test on different screen sizes if UI-related
  • Make sure drawing, clearing, and exporting patterns still work
  • Ensure no console errors are introduced

📌 Code of Conduct

  • Be respectful and constructive
  • Welcome beginners and first-time contributors
  • Provide helpful feedback

Harassment or toxic behavior will not be tolerated.

🙌 Thank You

Every contribution matters — from fixing a typo to adding a new feature.

If you have ideas or questions, feel free to open an Issue or start a discussion.

Happy contributing! 🎉