Skip to content

Latest commit

 

History

History
108 lines (82 loc) · 3.16 KB

CONTRIBUTING.md

File metadata and controls

108 lines (82 loc) · 3.16 KB

🤝 Contributing to ngx-product-gallery

Hello, awesome developer! 👋
First off, thank you for considering contributing to ngx-product-gallery – you rock! 🤘

We’re excited to collaborate with you to make this library even better. Whether it's fixing a bug 🐛, adding a feature ✨, or improving documentation 📖, your help is always welcome.

🚀 How to Contribute

1. Fork the Repo

Start by forking this repository. It’s your personal copy to experiment and make changes. 🎨
👉 Fork it here.

2. Clone the Repo

Get the code on your local machine:

git clone https://github.com/rohtashsethi/ngx-product-gallery.git
cd ngx-product-gallery

3. Create a Branch

Make a new branch for your feature or bug fix. Use a meaningful name!

git checkout -b fix/gallery-bug

4. Install Dependencies

Make sure you have everything set up:

npm install

5. Make Your Changes

  • Add or improve code in the src/ folder.
  • Follow the existing coding style.
  • Don’t forget to include/update tests! 🚨

6. Test Your Changes

Run the tests to ensure your changes didn’t break anything:

npm run test

7. Commit Your Changes

Write clear, meaningful commit messages. Use this format:

type(scope): message

Examples:
- feat(gallery): add zoom feature to gallery
- fix(thumbnails): resolve thumbnail overlap issue
- docs(README): improve installation instructions

8. Push and Submit a PR

Push your changes to your forked repo and submit a pull request to the main branch:

git push origin your-branch-name

👀 Guidelines for Contributions

Code Standards

  • Follow Angular's best practices and use TypeScript.
  • Ensure your code is modular and reusable.
  • Keep it DRY (Don’t Repeat Yourself).

Commit Messages

Documentation

  • Update or create documentation for your changes.
  • Make sure it’s clear and beginner-friendly.

Testing

  • Write or update unit tests for your changes.
  • Ensure all tests pass before submitting a PR.

🐛 Found a Bug?

  • Check if an issue already exists. If not, create one here.
  • Provide as much detail as possible, including steps to reproduce.

✨ Want to Add a Feature?

  • Open a new feature request here.
  • Let’s discuss your idea before you start coding!

💬 Need Help?

🎉 Let’s Make It Happen!

Thank you again for contributing to ngx-product-gallery. Let’s build something amazing, together! 🌟
Cheers,
Rohtash Sethi – Maintainer