|
| 1 | +# 🤝 Contributing to GitHub Pattern Generator |
| 2 | + |
| 3 | +First of all, thank you for taking the time to contribute! ❤️ |
| 4 | +This project exists because of the open-source community, and **all kinds of contributions are welcome**. |
| 5 | + |
| 6 | +Whether you’re here to improve the UI, add animations, optimize logic, or fix a small bug — you’re awesome. |
| 7 | + |
| 8 | +--- |
| 9 | + |
| 10 | +## 🌟 Ways You Can Contribute |
| 11 | + |
| 12 | +You can help this project in many ways: |
| 13 | + |
| 14 | +### 🎨 Design & UI/UX Improvements |
| 15 | +- Improve button styles, layout, or spacing |
| 16 | +- Add smooth animations or transitions |
| 17 | +- Enhance responsiveness for mobile/tablet |
| 18 | +- Improve color contrast or accessibility |
| 19 | + |
| 20 | +### 🧠 Logic & Functionality |
| 21 | +- Optimize grid interaction logic |
| 22 | +- Improve pattern export (`pattern.json`) structure |
| 23 | +- Add new features or configuration options |
| 24 | +- Improve performance or code readability |
| 25 | + |
| 26 | +### 🐛 Bug Fixes |
| 27 | +- Fix UI glitches or unexpected behavior |
| 28 | +- Handle edge cases in pattern drawing/export |
| 29 | +- Improve error handling |
| 30 | + |
| 31 | +### 📖 Documentation |
| 32 | +- Improve README or add examples |
| 33 | +- Fix typos or unclear explanations |
| 34 | +- Add comments to the code for clarity |
| 35 | + |
| 36 | +--- |
| 37 | + |
| 38 | +## 🛠️ Getting Started |
| 39 | + |
| 40 | +### 1️⃣ Fork the Repository |
| 41 | +Click the **Fork** button on GitHub to create your own copy of the project. |
| 42 | + |
| 43 | +### 2️⃣ Clone Your Fork |
| 44 | +```bash |
| 45 | +git clone https://github.com/your-username/github-pattern-generator.git |
| 46 | +``` |
| 47 | + |
| 48 | +### 3️⃣ Create a New Branch |
| 49 | +```bash |
| 50 | +git checkout -b feature/your-feature-name |
| 51 | +``` |
| 52 | + |
| 53 | +Use clear branch names like: |
| 54 | +- `ui/button-animation` |
| 55 | +- `fix/export-bug` |
| 56 | +- `feature/grid-enhancement` |
| 57 | + |
| 58 | +--- |
| 59 | + |
| 60 | +## 💻 Development Guidelines |
| 61 | + |
| 62 | +- Keep the project **framework-free** (HTML, CSS, JavaScript only) |
| 63 | +- Write **clean, readable code** |
| 64 | +- Follow existing code style |
| 65 | +- Avoid unnecessary dependencies |
| 66 | +- Test your changes in the browser before submitting |
| 67 | + |
| 68 | +--- |
| 69 | + |
| 70 | +## ✅ Commit Message Guidelines |
| 71 | + |
| 72 | +Use simple and meaningful commit messages: |
| 73 | + |
| 74 | +- `feat: add hover animation to buttons` |
| 75 | +- `fix: resolve export json bug` |
| 76 | +- `ui: improve grid responsiveness` |
| 77 | +- `docs: update README usage section` |
| 78 | + |
| 79 | +--- |
| 80 | + |
| 81 | +## 📤 Submitting a Pull Request |
| 82 | + |
| 83 | +1. Push your changes to your fork |
| 84 | +2. Open a Pull Request to the `main` branch |
| 85 | +3. Clearly describe: |
| 86 | + - What you changed |
| 87 | + - Why the change is needed |
| 88 | + - Any screenshots or GIFs (for UI changes) |
| 89 | + |
| 90 | +Your PR will be reviewed as soon as possible 🚀 |
| 91 | + |
| 92 | +--- |
| 93 | + |
| 94 | +## 🧪 Testing |
| 95 | + |
| 96 | +- Test on different screen sizes if UI-related |
| 97 | +- Make sure drawing, clearing, and exporting patterns still work |
| 98 | +- Ensure no console errors are introduced |
| 99 | + |
| 100 | +--- |
| 101 | + |
| 102 | +## 📌 Code of Conduct |
| 103 | + |
| 104 | +- Be respectful and constructive |
| 105 | +- Welcome beginners and first-time contributors |
| 106 | +- Provide helpful feedback |
| 107 | + |
| 108 | +Harassment or toxic behavior will not be tolerated. |
| 109 | + |
| 110 | +--- |
| 111 | + |
| 112 | +## 🙌 Thank You |
| 113 | + |
| 114 | +Every contribution matters — from fixing a typo to adding a new feature. |
| 115 | + |
| 116 | +If you have ideas or questions, feel free to open an **Issue** or start a discussion. |
| 117 | + |
| 118 | +Happy contributing! 🎉 |
| 119 | + |
0 commit comments