Reporting Issues

Reporting Issues

For comprehensive guidance, see: Bug Reporting & Diagnostics Guide

---

🚨 Best Way: Use ChurchCRM's Built-in Issue Reporter

For the fastest and most accurate support, report bugs directly from your ChurchCRM installation:

Step-by-Step Instructions

1. Log into your ChurchCRM instance
2. Navigate to Support
   • Look for the "Support" menu or help icon (usually in the top navigation)
3. Select "Report an Issue"
   • This opens the built-in issue reporting tool
4. Fill out the form
   • Describe what happened
   • Include steps to reproduce
   • Add any relevant screenshots
5. Submit
   • The system automatically captures your technical environment
   • Your report is sent to the development team

What Gets Captured Automatically

When you use the in-app reporter, we automatically collect:

• ✅ ChurchCRM Version - Exact version and build info
• ✅ Server Environment - PHP version, database type, server OS
• ✅ Browser Information - User agent, capabilities, screen size
• ✅ User Context - Your role, permissions, current page
• ✅ System Configuration - Relevant settings and modules enabled
• ✅ Error Logs - Recent errors related to your session

This information is crucial for debugging and helps us resolve issues much faster!

📋 Alternative: GitHub Issues

Only use GitHub issues if you cannot access ChurchCRM:

When to Use GitHub Instead

• 🚫 Cannot log in - Login/authentication issues
• 🚫 Installation problems - Before ChurchCRM is set up
• 🚫 Server completely down - Cannot access the application
• 📖 Documentation issues - Problems with guides or wiki
• 💻 Development setup - Issues with local development environment

GitHub Issue Templates

We have several templates to choose from:

1. Bug Report - For software defects
2. Feature Request - For new functionality
3. Question - For support questions

💬 Other Support Options

Community Discussion

• GitHub Discussions - Ask questions, share ideas
• General questions about setup, configuration, or usage
• Community solutions and best practices

Documentation

• ChurchCRM Wiki - Comprehensive guides
• Installation instructions
• Configuration tutorials
• Troubleshooting guides

🔍 Before Reporting

Quick Checks

1. Search existing issues - Someone might have already reported it
2. Check the documentation - The solution might already exist
3. Try in a different browser - Rule out browser-specific issues
4. Clear browser cache - Old cached files can cause problems

Information to Include

If you must use GitHub issues, please include:

• Clear description of what happened
• Steps to reproduce the issue
• Expected vs actual behavior
• Screenshots or error messages
• ChurchCRM version (found in About/System Info)
• Browser and device you're using

🚀 Quick Access

I want to...	Best Option
Report a bug	🚨 In-app Support → Report Issue
Request a feature	💡 GitHub Feature Request
Ask a question	💬 GitHub Discussions
Report login issue	🐛 GitHub Bug Report
Find documentation	📚 ChurchCRM Wiki

---

Thank you for helping make ChurchCRM better! Your reports help us improve the software for everyone. 🙏

1. Log into your ChurchCRM instance
2. Navigate to Support
   • Look for the "Support" menu or help icon (usually in the top navigation)
3. Select "Report an Issue"
   • This opens the built-in issue reporting tool
4. Fill out the form
   • Describe what happened
   • Include steps to reproduce
   • Add any relevant screenshots
5. Submit
   • The system automatically captures your technical environment
   • Your report is sent to the development team

What Gets Captured Automatically

When you use the in-app reporter, we automatically collect:

• ✅ ChurchCRM Version - Exact version and build info
• ✅ Server Environment - PHP version, database type, server OS
• ✅ Browser Information - User agent, capabilities, screen size
• ✅ User Context - Your role, permissions, current page
• ✅ System Configuration - Relevant settings and modules enabled
• ✅ Error Logs - Recent errors related to your session

This information is crucial for debugging and helps us resolve issues much faster!

📋 Alternative: GitHub Issues

Only use GitHub issues if you cannot access ChurchCRM:

When to Use GitHub Instead

• 🚫 Cannot log in - Login/authentication issues
• 🚫 Installation problems - Before ChurchCRM is set up
• 🚫 Server completely down - Cannot access the application
• 📖 Documentation issues - Problems with guides or wiki
• 💻 Development setup - Issues with local development environment

GitHub Issue Templates

We have several templates to choose from:

1. Bug Report - For software defects
2. Feature Request - For new functionality
3. Question - For support questions

💬 Other Support Options

Community Discussion

• GitHub Discussions - Ask questions, share ideas
• General questions about setup, configuration, or usage
• Community solutions and best practices

Documentation

• ChurchCRM Wiki - Comprehensive guides
• Installation instructions
• Configuration tutorials
• Troubleshooting guides

🔍 Before Reporting

Quick Checks

1. Search existing issues - Someone might have already reported it
2. Check the documentation - The solution might already exist
3. Try in a different browser - Rule out browser-specific issues
4. Clear browser cache - Old cached files can cause problems

Information to Include

If you must use GitHub issues, please include:

• Clear description of what happened
• Steps to reproduce the issue
• Expected vs actual behavior
• Screenshots or error messages
• ChurchCRM version (found in About/System Info)
• Browser and device you're using

🚀 Quick Access

I want to...	Best Option
Report a bug	🚨 In-app Support → Report Issue
Request a feature	💡 GitHub Feature Request
Ask a question	💬 GitHub Discussions
Report login issue	🐛 GitHub Bug Report
Find documentation	📚 ChurchCRM Wiki

---

Thank you for helping make ChurchCRM better! Your reports help us improve the software for everyone. 🙏