Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
120 lines (87 loc) · 3.98 KB

CONTRIBUTING.md

File metadata and controls

120 lines (87 loc) · 3.98 KB
Raw

Contributing to Sokuji

Thank you for your interest in contributing to Sokuji! We welcome contributions from the community, but please read these guidelines carefully before submitting any issues or pull requests.

🚨 Important Notice

This project is focused on technical development and user experience improvements. Issues that are not related to code, features, bugs, or technical discussions will be closed immediately without response.

✅ What We Accept

Bug Reports

  • Technical issues with the application
  • Reproducible errors or unexpected behavior
  • Performance problems
  • UI/UX issues
  • Installation or setup problems

Feature Requests

  • New functionality suggestions
  • User experience improvements
  • Technical enhancements
  • Integration requests

Technical Discussions

  • Architecture discussions
  • Code quality improvements
  • Security concerns (technical)
  • Performance optimization ideas

❌ What We Do NOT Accept

The following types of issues will be closed immediately without response:

Project Management Issues

  • Complaints about star counts or repository statistics
  • Demands to make the repository private
  • Requests to change repository URLs or ownership
  • Accusations about "fake stars" or similar claims
  • General project management suggestions unrelated to code

Non-Technical Discussions

  • General opinions about the project direction (use Discussions instead)
  • Marketing or promotion suggestions
  • Community management topics
  • Off-topic discussions

Harassment or Spam

  • Repeated submissions of the same issue
  • Coordinated harassment campaigns
  • Issues created solely to disrupt development
  • Baseless accusations or inflammatory content

📋 Before Creating an Issue

  1. Search existing issues to avoid duplicates
  2. Read our documentation thoroughly
  3. Test with the latest version of the application
  4. Choose the appropriate template (Bug Report or Feature Request)
  5. Provide complete information as requested in the template

🔧 Issue Templates

We provide structured templates for:

  • 🐛 Bug Reports: For technical issues and bugs
  • ✨ Feature Requests: For new features and enhancements

Blank issues are disabled. You must use one of the provided templates.

📝 Writing Good Issues

For Bug Reports

  • Provide clear steps to reproduce the issue
  • Include your environment details (OS, browser, version)
  • Add screenshots or error logs when applicable
  • Describe expected vs actual behavior

For Feature Requests

  • Explain the problem you're trying to solve
  • Describe your proposed solution clearly
  • Consider and mention alternative approaches
  • Provide use cases and examples

🚀 Pull Requests

We welcome code contributions! Please:

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes with clear commit messages
  4. Test your changes thoroughly
  5. Submit a pull request with a clear description

📞 Getting Help

  • Technical Questions: Use our issue templates
  • General Discussions: Use GitHub Discussions
  • Documentation: Check our README

⚖️ Code of Conduct

  • Be respectful and constructive
  • Focus on technical matters
  • Avoid spam, harassment, or off-topic discussions
  • Follow GitHub's Community Guidelines

🛡️ Enforcement

Issues that violate these guidelines will be:

  1. Closed immediately without discussion
  2. Labeled appropriately (e.g., "invalid", "spam", "off-topic")
  3. Reported to GitHub if they constitute harassment or spam

Repeated violations may result in blocking users from the repository.

📧 Contact

For matters that don't fit into issues or discussions, you can contact the maintainers directly through GitHub.

Remember: This is an open-source project maintained by volunteers. Please be respectful of our time and focus on constructive, technical contributions that help improve the software for everyone.