Skip to content

Latest commit

 

History

History
72 lines (47 loc) · 3.37 KB

CONTRIBUTING.md

File metadata and controls

72 lines (47 loc) · 3.37 KB
Raw

Contributing Guidelines for GDSC Club Official Website at IIITL

🎉 Welcome, Awesome Contributor! 🎉

First and foremost, a big THANK YOU for showing interest in enhancing the GDSC official website! Your enthusiasm and contribution mean a lot to us. Let's make this collaboration a memorable one. Before diving in, let's go through some guidelines to ensure our journey together is smooth and rewarding.

Table of Contents

Code of Conduct

🌟 By joining us in this initiative, you're pledging to uphold our Code of Conduct. Remember, every interaction counts, so let's keep it respectful, positive, and uplifting!

How to Contribute

  1. Fork the Repository: Make a copy of our repository to your GitHub playground.

  2. Clone & Dive In: Get the codebase on your local machine and start exploring:

    git clone https://github.com/[YourUsername]/gdsc-iiitl-official.git

  3. Branch Out: Create a fresh branch for your innovative contributions:

    git checkout -b feature/your-feature-name

Encountering issues? For assistance or troubleshooting, refer to our wiki or create an issue for support.

Pull Requests

  1. Adhere to Style: Check out our Style Guide to ensure your code shines bright.

  2. Test & Validate: Before sharing your magic with us, make sure everything runs smoothly on your end.

  3. Commit with Clarity: Craft meaningful commit messages that tell a story.

  4. Share Your Brilliance: Push your work to your forked repository:

    git push origin feature/your-feature-name

  5. Merge with Main: Propose your changes through a pull request, and let's celebrate your contribution together!

Style Guidelines

  • 🎨 Embrace our coding standards detailed in the Style Guide.
  • 📝 Prettify: Use prettier to sprinkle some formatting magic.
  • 🚦 ESLint & Husky: Let's maintain top-notch quality. Run yarn lint and follow husky's guidance for linting and formatting.
  • 📌 Clear Communication: Your code speaks volumes; make sure it's a bestseller with clear comments and variable names.

Reporting Bugs

🐛 Stumbled upon a bug? No worries! Help us squash it by reporting it here. Provide all the juicy details, and let's fix it together!

Feature Requests

✨ Got a spark of an idea? We're all ears! Share your feature requests or enhancements right here. Your vision could shape our next big thing!

Contact

💌 Have queries or need a buddy to guide you? Drop us a line at gdsc@iiitl.ac.in. We're here to support and cheer you on!

Let's code, collaborate, and create magic together! 🚀