We love open-source contributions! Whether you're fixing a bug, adding a new feature, or improving documentation, we appreciate your help in making ShoplyJS better. This guide will help you get started with contributing to the ShoplyJS project.
- Code of Conduct
- How to Contribute
- Development Setup
- Coding Guidelines
- Test Guidelines
- Documentation
- Style Guide
- License
Please review and follow our Code of Conduct. We are committed to maintaining a respectful and inclusive environment for all contributors.
If you find a bug, have a feature request, or encounter any other issues, please open an issue in the repository. Be sure to include as much detail as possible:
- Steps to reproduce the issue (if applicable)
- Expected and actual behavior
- Version of ShoplyJS you're using
- Your environment details (browser, OS, etc.)
If you'd like to contribute code, follow these steps:
- Fork the repository and clone it to your local machine.
- Create a new branch for your changes (
git checkout -b feature-name). - Make your changes and write meaningful commit messages.
- Run the tests and ensure everything works as expected.
- Push your changes to your fork (
git push origin feature-name). - Create a pull request to the main branch of the ShoplyJS repository.
- Ensure your pull request adheres to the coding guidelines.
We will review your pull request and get back to you as soon as possible. If we need any changes, we'll provide feedback.
- Node.js (version >=x.x.x)
- npm or yarn (depending on your preference)
- Clone the repository:
git clone https://github.com/<your-org>/shoplyjs.git cd shoplyjs