Skip to content

Latest commit

 

History

History
88 lines (62 loc) · 3.21 KB

CONTRIBUTING.md

File metadata and controls

88 lines (62 loc) · 3.21 KB

🖼️ Contributing to WallGodds

Welcome to WallGodds, a community-driven platform for high-quality, categorized wallpapers! 🌟 We’re thrilled to have you here and can’t wait to see how you’ll help us enhance this project. Whether you're a developer, designer, or enthusiast, your contributions will help make WallGodds the go-to hub for stunning wallpapers. 🚀

🚀 How to Contribute?

1. Star and Fork the Repository

  • Hit the ⭐ Star button to show your support for WallGodds.
  • Fork this repository to your GitHub account to work on your personalized copy of the project.

2. Clone the Repository

After forking, clone the repository to your local machine:

git clone https://github.com/<your-username>/WallGodds.git

Replace <your-username> with your GitHub username.

3. Create a New Branch

Create a new branch for your changes to keep your work organized:

git checkout -b <your-branch-name>

Use a descriptive branch name, such as the feature you’re working on (e.g., add-upload-feature, fix-footer-styling).

4. Make Your Changes

  • Add new features or improve existing ones (e.g., profile pages, wallpaper categories, upload functionality).
  • Ensure your code follows the project’s conventions and standards for structure and styling.

5. Commit Your Changes

Save your progress with clear and descriptive commit messages:

git commit -m "Added functionality to upload wallpapers with preview"

6. Push Your Changes

Push your branch to your forked repository:

git push origin <your-branch-name>

7. Submit a Pull Request (PR)

Submit your work for review:

  • Go to the original repository on GitHub.
  • Click the Pull Requests tab and select New Pull Request.
  • Choose your branch and describe your changes:
    • Reference any issues your PR addresses (e.g., Fixes #42) [if exists].
    • Explain the purpose of your changes and how they improve WallGodds.

🌟 Additional Contribution Guidelines

  • Follow the Code Style: Consistency matters! Stick to the existing coding conventions.
  • Add Documentation: If you're introducing a new feature, update relevant docs or the README.
  • Test Your Changes: Ensure everything works as intended by testing your additions locally.
  • Link Issues: Use Fixes #<issue-number> in your PR description to automatically close issues upon merge.

📂 Figma File for Designers

We’ve uploaded the design prototype for WallGodds on Figma to help developers align with the design team. Access the Figma file here: WallGodds Design on Figma.

💡 Need Help?

If you encounter challenges, here’s how you can reach out:

  • Open an issue with your query, and we’ll respond as soon as possible.
  • Join our community discussions for collaborative problem-solving [coming soon].
  • Tag project maintainers in your pull request for personalized support.

Thank you for helping us make WallGodds an amazing platform for wallpaper enthusiasts! Together, we can create a stunning, user-friendly experience for everyone. 🌍