Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
99 lines (77 loc) · 2.65 KB

CONTRIBUTING.md

File metadata and controls

99 lines (77 loc) · 2.65 KB
Raw

Contributing to Sim-Thailand 2569 🇹🇭

Thank you for your interest in contributing to Sim-Thailand 2569! This document provides guidelines for contributing to the project.

🤝 How to Contribute

Reporting Issues

If you find a bug or want to request a new feature, please create an issue using the following format:

Bug Report:

  • Title: Clear and descriptive
  • Description: Steps to reproduce the bug
  • Expected behavior: What should happen
  • Actual behavior: What actually happens
  • Screenshots (if applicable)

Feature Request:

  • Title: Clear and descriptive
  • Description: Detailed explanation of the feature
  • Use case: Why this feature would be helpful
  • Implementation suggestions (if any)

Pull Requests

We welcome pull requests! Here's how to contribute:

  1. Fork the repository - Fork the main repository
  2. Create a feature branch - git checkout -b feature/amazing-feature
  3. Make your changes - Follow the coding standards below
  4. Test your changes - Run npm run build to ensure it builds successfully
  5. Commit your changes - Use conventional commit format
  6. Push to your fork - git push origin feature/amazing-feature
  7. Create a Pull Request - Clear description of changes made

📝 Coding Standards

JavaScript/HTML/CSS

  • Use ES6+ JavaScript features
  • Follow existing code style and formatting
  • Use meaningful variable and function names
  • Add comments for complex logic
  • Ensure responsive design for mobile devices

Git Commit Messages

Use conventional commit format:

feat: add new feature
fix: resolve bug
docs: update documentation
style: format code
refactor: restructure code
test: add tests
chore: maintenance

Pull Request Template

## Description
Brief description of the changes

## Changes Made
- [ ] Change 1
- [ ] Change 2
- [ ] Change 3

## Testing
- [ ] Tested on Chrome
- [ ] Tested on Firefox
- [ ] Tested on Mobile

## Related Issue
Closes #123

📁 Project Structure

ThaiSim2569/
├── src/
│   ├── js/           # JavaScript files
│   └── css/          # CSS styles
├── Campaign2569/     # Political campaign data
├── dist/            # Build output
└── docs/            # Documentation

🔧 Development Setup

  1. Clone the repository
  2. Install dependencies: npm install
  3. Run development server: npm run dev
  4. Build for production: npm run build

📄 License

By contributing to this project, you agree that your contributions will be licensed under the MIT License.

🙏 Acknowledgments

Thank you for contributing to Sim-Thailand 2569! Your help makes this educational resource better for everyone.