Skip to content

Latest commit

 

History

History
56 lines (38 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

56 lines (38 loc) · 1.63 KB
Raw

Contributing to ZenUI Library

Thank you for considering contributing to ZenUI Library! This document outlines the steps for contributing to the project.

How Can I Contribute?

1. Reporting Bugs

If you encounter any issues, please report them by creating an issue. Provide detailed information to help us resolve the issue quickly.

2. Suggesting Features

Have an idea to improve ZenUI? Submit your ideas by opening an issue and labeling it as a feature request.

3. Pull Requests

Follow these steps to submit a pull request:

  • Fork the repository.
    Clone your fork:
git clone https://github.com/<your-username>/zenui-library.git

Create a new branch:

git checkout -b feature/new-feature

Make your changes and commit:

git commit -m "Add a new feature"

Push your branch:

git push origin feature/new-feature
  • Create a pull request on the original repo.

Coding Guidelines

  • Detailed Commit Messages When committing changes, provide a detailed commit message explaining what you worked on and what issue was solved. Follow this format:
git commit -m "Fix issue #123: Add a new feature for XYZ component following the standard code structure. Refactored ABC for better readability and resolved bugs related to..."

This ensures clarity and traceability of changes for reviewers and contributors.

  • Ensure that your code is well-documented and follows best practices.

Code of Conduct

Please adhere to the Code of Conduct to ensure a welcoming and respectful environment for all contributors.