Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
89 lines (79 loc) · 3.34 KB

CONTRIBUTING.md

File metadata and controls

89 lines (79 loc) · 3.34 KB

Contributing Guide

Thank you for your interest in contributing to SimplePanel-CS2! This document provides guidelines and standards for contributing to the project.

📜 Code of Conduct

By participating in this project, you commit to maintaining a respectful and welcoming environment for all contributors.

🤝 How to Contribute

Reporting Bugs

If you find a bug, please:

  1. Check that the bug hasn't already been reported in Issues
  2. Create a new issue with the tag [BUG] and include:
    • A clear, descriptive title
    • Detailed steps to reproduce the issue
    • Expected behavior vs actual behavior
    • Environment information (OS, Node.js version, browser, etc.)
    • Screenshots or error logs if applicable

Security Issues

If you find a security vulnerability, please DO NOT report it publicly. Instead, contact the repository owner directly through GitHub.

💡 Suggesting Features & Enhancements

Suggestions for new features and improvements are welcome! Please follow these steps:

  1. Check existing issues to ensure your suggestion hasn't already been proposed
  2. Open an issue with the [SUG] tag and include:
    • A clear description of the proposed feature
    • The specific problem it solves or value it adds
    • How the feature should work and any relevant use cases
    • Examples, references, or mockups if available
    • Why this enhancement would be useful to the project

Contributing Code

  1. Fork the repository
  2. Create a branch for your feature: 
    git checkout -b feature/your-feature-name
    Or for fixes: 
    git checkout -b fix/fix-description
  3. Make your changes following the code standards
  4. Commit your changes: 
    git commit -m "Clear description of your changes"
    • Use descriptive commit messages
    • Mention the issue number if applicable (e.g., "Fix #123: Fixes error in...")
  5. Push to your fork: 
    git push origin feature/your-feature-name
  6. Open a Pull Request:
    • Clearly describe the changes made
    • Mention any related issues
    • Wait for review from the code owner

🔄 Pull Request Process

  1. Ensure your code follows the project's standards
  2. Ensure all tests pass (if they exist)
  3. Update documentation if necessary
  4. The code owner will review your PR
  5. There may be change requests - please be receptive to feedback
  6. Once approved, your PR will be merged

📝 Code Standards

Code Style

  • Follow the existing code style in the project
  • Use descriptive names for variables and functions
  • Comment complex code when necessary
  • Keep functions small and focused

Commit Structure

  • Use clear and descriptive commit messages
  • Suggested format: type: Brief description
    • Examples: feat: Add notification system, fix: Fix form validation error
  • Common types: feat, fix, docs, style, refactor

Files and Folders

  • Maintain an organized file structure
  • Use descriptive file names
  • Group related files in appropriate folders

❓ Questions

If you have questions about how to contribute, you can:

  • Open an issue with the question label
  • Review the existing documentation in the README

🙏 Acknowledgments

Thank you for taking the time to contribute to SimplePanel-CS2! Your help makes this project better for everyone.