Skip to content

Latest commit

 

History

History
65 lines (43 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

65 lines (43 loc) · 2.25 KB

Contributing to Wick Apps

First off, thank you for considering contributing to Wick Apps! It's contributors like you that make this project a valuable resource for the community. This document provides guidelines for contributing to the project.

Table of Contents

Getting Started

  • Ensure you have the latest version of the Wick framework installed.
  • Familiarize yourself with the existing example applications to avoid duplicating efforts.

Style Guide

Please ensure that your code adheres to the general style of the existing examples:

  • Comment your code clearly.
  • Use meaningful variable and function names.
  • For JavaScript, HTML, and other web-related technologies, follow standard best practices and formatting.

How Can I Contribute?

Reporting Bugs

Before reporting a bug, please check the existing issues to see if someone has reported the same problem. If there isn't an existing issue, create a new issue and provide the following details:

  • A clear and descriptive title.
  • Steps to reproduce the issue.
  • Expected behavior.
  • Actual behavior.
  • Any related logs or error messages.

Suggesting Enhancements

If you have ideas for new example applications or improvements to existing ones:

  • Provide a clear and descriptive title.
  • Describe the use case and why it's valuable to the community.
  • Offer a detailed description of the execution.

Submitting a Pull Request

  1. Fork the repository.
  2. Create a new branch based on main (or default branch).
  3. Implement your changes or new example.
  4. Test your changes.
  5. Push your branch to your fork.
  6. Create a pull request, providing a detailed description of your changes.

Please understand that we might ask for changes to ensure consistency and quality within the repository.

Code of Conduct

By participating in this project, you're expected to uphold our Code of Conduct.


Thank you for helping improve Wick Apps and making the Wick community even better!