Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 2.44 KB

CONTRIBUTING.md

File metadata and controls

50 lines (32 loc) · 2.44 KB

Contributing to CSS to YAML Converter

We appreciate your interest in contributing to the CSS to YAML Converter project! This document outlines the guidelines for submitting code and reporting issues.

How to Contribute

There are several ways you can contribute to the project:

  • Bug fixes: Identify and submit fixes for existing bugs in the code.
  • Feature enhancements: Propose and implement new features that improve the functionality of the converter.
  • Documentation improvements: Help us enhance the clarity and comprehensiveness of the project's documentation (README.md and this CONTRIBUTING.md).
  • Testing: Write unit tests to ensure the robustness of the codebase.

Getting Started

Before submitting a contribution, please follow these steps:

  1. Fork the repository: Create a fork of this repository on GitHub.
  2. Clone your fork: Clone your forked repository to your local machine.
  3. Create a new branch: Create a new branch for your specific contribution.
  4. Make changes: Make your changes to the codebase.
  5. Write unit tests (if applicable): If your contribution involves code changes, write unit tests to verify the functionality.
  6. Commit your changes: Commit your changes with a clear and concise commit message.
  7. Push your changes: Push your changes to your forked repository on GitHub.
  8. Create a pull request: Open a pull request from your branch to the main branch of the upstream repository.

Pull Request Guidelines

  • Ensure your code adheres to the existing code style and formatting conventions.
  • Write clear and concise commit messages that describe the changes you made.
  • Include unit tests for any new functionality or bug fixes you implement.
  • If your contribution introduces significant changes, consider opening an issue first to discuss the approach.

Reporting Issues

If you encounter any bugs or have suggestions for improvement, please report them by opening an issue on the project's GitHub repository. When reporting an issue, please provide the following information:

  • A clear description of the issue
  • Steps to reproduce the issue (if applicable)
  • Expected behavior vs. actual behavior
  • Any relevant error messages or logs

License

Contributions to this project are licensed under the MIT License. By submitting a pull request, you agree to license your contribution under this license.

We appreciate your contributions and look forward to working with you!