70 lines (51 loc) · 1.93 KB

Contributing to Job Description Deep Analyzer

Thank you for your interest in contributing! This document provides guidelines for contributing to this project.

How to Contribute

Reporting Bugs

If you find a bug, please create an issue with:

A clear, descriptive title
Steps to reproduce the issue
Expected behavior
Actual behavior
Your environment (OS, browser, LM Studio version, model used)
Screenshots if applicable

Suggesting Features

Feature suggestions are welcome! Please create an issue with:

A clear description of the feature
Why this feature would be useful
Any implementation ideas you might have

Pull Requests

Fork the repository and create your branch from main
Make your changes:
- Keep changes focused and atomic
- Follow the existing code style
- Test your changes thoroughly
Update documentation if needed
Commit your changes with clear, descriptive commit messages
Push to your fork and submit a pull request

Code Style

Use clear, descriptive variable names
Add comments for complex logic
Keep functions focused and single-purpose
Maintain consistent indentation (spaces, not tabs)
Follow existing HTML/CSS/JavaScript patterns

Testing

Before submitting a PR:

Test in multiple browsers (Chrome, Firefox, Edge)
Test with different LM Studio models
Verify all analysis modules work correctly
Check that export functions work properly
Test the user guide carousel

Development Setup

Clone your fork
Open standalone_jd_analysis_cm_user_guide_gemini.html in a browser
Have LM Studio running with a model loaded
Make your changes and test

Questions?

Feel free to create an issue for any questions about contributing.

Code of Conduct

Be respectful and inclusive
Provide constructive feedback
Focus on what's best for the community
Show empathy towards other contributors

Thank you for contributing! 🎉