diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..88553d5 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,60 @@ +***# Pull Request Template πŸš€*** + + + +***## Description*** + +***Please include a summary of the changes and the related issue.*** + +***Explain the motivation and context.*** + + + +***## Type of Change*** + +***- \[ ] Bug fix*** + +***- \[ ] New feature*** + +***- \[ ] Documentation update*** + +***- \[ ] Other (please describe):*** + + + +***## How Has This Been Tested?*** + +***Explain how you tested your changes.*** + + + +***## Checklist*** + +***- \[ ] My code follows the project’s style guidelines*** + +***- \[ ] I have performed a self-review of my own code*** + +***- \[ ] I have commented my code, particularly in hard-to-understand areas*** + +***- \[ ] I have added necessary documentation (if applicable)*** + +***- \[ ] My changes do not break the existing functionality*** + + + +***## Screenshots (if applicable)*** + +***Add screenshots to help explain your changes.*** + + + +***## Additional Notes*** + +***Any other information you want to share with the maintainers.*** + + + +***✨ Thank you for contributing to Guessync! 🎢*** + + + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..260c173 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,52 @@ +# 🀝 Contributing to Guessync + +Thanks for your interest in contributing to **Guessync**! 🎢 +We welcome contributions of any kind β€” code, documentation, bug reports, feature requests, or design improvements. + +--- + +## πŸš€ How to Contribute + +### 1. Fork & Clone +1. Fork the repo on GitHub. +2. Clone your fork locally: +```bash +git clone https://github.com//Guessync.git +cd Guessync +``` +### 2. Create a Branch +Always create a new branch for your feature or fix: +```bash +git checkout -b feature/your-feature-name +``` + +### 3. Make Your Changes +- For code: follow existing structure & best practices +- For documentation: keep it clear and concise +- For UI/UX: keep consistent with existing design + +### 4. Stage & Commit +```bash +git add . +git commit -m "feat/docs: add explanation about XYZ" +``` + +### 5. Push & Open a Pull Request +```bash +git push origin feature/your-feature-name +``` +- Go to GitHub β†’ Compare & Pull Request +- Write a descriptive title & short summary +- Submit PR for review πŸš€ + +## πŸ“Œ Guidelines +- Be respectful & collaborative +- Include screenshots or GIFs for visual changes +- Write clear commit messages +- Keep PRs focused on one change per PR + +## πŸ› οΈ Reporting Issues +- Open an issue on GitHub with a clear description +- Tag it with labels like bug, enhancement, or documentation + +Thank you for helping make Guessync better for everyone! πŸŽ‰ \ No newline at end of file