Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
126 lines (79 loc) · 3.64 KB

CONTRIBUTING.md

File metadata and controls

126 lines (79 loc) · 3.64 KB

Contribution

Thank you for your interest in contributing to the Playful Sparkle Live Search extension! We value contributions from the community to enhance this project for all users. Whether you're fixing bugs, adding features, improving documentation, or translating the extension, your efforts are greatly appreciated.

Code of Conduct

By participating in this project, you agree to adhere to our Code of Conduct. Please review it before engaging with the community.

Getting Started

Prerequisites

To contribute effectively, ensure you have:

  • A basic understanding of Git and GitHub workflows
  • Familiarity with OpenCart platforms
  • PHP and JavaScript development experience (for code contributions)
  • Access to a local or test OpenCart environment for validating changes

How to Contribute

Reporting Issues

To report an issue:

  1. Review the existing issues to avoid duplicates.
  2. Provide detailed information, including:
    • OpenCart version
    • Steps to reproduce the issue
    • Screenshots (if applicable)
    • Relevant error logs (if available)

Suggesting Features

To propose a new feature, open an issue and include:

  • The problem your feature addresses
  • A clear and concise description of the proposed solution
  • Relevant use cases or examples

Submitting Pull Requests

To submit a pull request (PR):

  1. Fork the repository.
  2. Create a descriptive branch: git checkout -b feat/your-feature-name or fix/your-bug-name
  3. Commit your changes with meaningful messages.
  4. Push your branch: git push origin your-branch-name
  5. Open a PR with a clear title and detailed description.

Pull Request Process

  1. Ensure your changes are compatible with supported OpenCart environments.
  2. Update relevant documentation (e.g., README, inline comments) as needed.
  3. Submit your PR for review. Maintainers may request changes.
  4. Once approved, your contribution will be merged into the project.

Style Guidelines

Code Standards

  • Adhere to PSR-12 coding standards for PHP.
  • Follow best practices for JavaScript, including ES6+ syntax.
  • Use descriptive and meaningful names for variables and functions.
  • Add comments to clarify complex logic.

Commit Messages

  • Write in present tense (e.g., "Add feature" instead of "Added feature").
  • Limit the first line to 72 characters.
  • Provide additional details in the body if necessary.

Translations

To contribute translations:

  1. Update the appropriate language files in /catalog/language/.
  2. Test the translations in your OpenCart environment.
  3. Submit a PR with the updated language files and specify the locale.

Testing Guidelines

To ensure the quality of your contributions:

  • Test changes in a local or test OpenCart environment.
  • Validate edge cases, such as different configurations or large catalogs.
  • Confirm that your changes do not conflict with core OpenCart functionality.

License Agreement

By contributing to this project, you agree that your work will be licensed under the project's GPL-3.0 License.

Contributor Recognition

We value and acknowledge significant contributions. Contributors may be recognized in:

  • The project's README
  • Release notes
  • A dedicated "Contributors" section

Questions or Support?

If you have any questions or need assistance, feel free to reach out via: