Getting Support


The nself community and maintainers are here to help you succeed with your backend infrastructure. This guide outlines all the ways you can get support and contribute to the project.

Community Support

GitHub Discussions

Best for: General questions, ideas, and community interaction

Our GitHub Discussions is the primary place for community support, feature discussions, and sharing projects built with nself.

  • πŸ’¬ Q&A: Get help with implementation questions
  • πŸ’‘ Ideas: Discuss feature requests and improvements
  • πŸš€ Show and tell: Share your nself projects
  • πŸ—£οΈ General: General discussions about nself

Visit: github.com/acamarata/nself/discussions

GitHub Issues

Best for: Bug reports, feature requests, and technical issues

Use GitHub Issues for reporting bugs, requesting features, or documenting technical problems that need fixes.

  • πŸ› Bug Reports: Report problems with nself
  • ✨ Feature Requests: Suggest new features
  • πŸ“š Documentation: Request documentation improvements
  • πŸ”§ Technical Issues: Platform-specific problems

Visit: github.com/acamarata/nself/issues

Before You Ask for Help

Self-Help Resources

Before reaching out for support, try these resources that might have your answer:

Documentation

Comprehensive guides covering installation, configuration, and usage patterns.

Start with: Documentation Home

FAQ

Common questions and answers covering most frequent issues.

Check: Frequently Asked Questions

Troubleshooting Guide

Step-by-step solutions for common problems and error scenarios.

Try: Troubleshooting Guide

Built-in Diagnostics

nself includes diagnostic tools to help identify issues quickly.

nself doctor

Diagnostic Information

When you do need help, provide diagnostic information to get faster, more accurate assistance:

# Generate comprehensive debug report
nself debug-report > debug_info.txt

# Or collect manually:
nself version
nself status --verbose
nself logs --tail 100
nself config show --sanitized  # Removes sensitive data

How to Ask Effective Questions

Bug Reports

When reporting bugs, include:

  • Clear Title: Concise description of the issue
  • Steps to Reproduce: Exact steps that trigger the bug
  • Expected vs Actual: What you expected vs what happened
  • Environment: OS, Docker version, nself version
  • Configuration: Relevant configuration (sanitized)
  • Logs: Error messages and relevant log entries

Bug Report Template

## Description
Brief description of the bug

## Steps to Reproduce
1. Step 1
2. Step 2
3. Step 3

## Expected Behavior
What should happen

## Actual Behavior  
What actually happened

## Environment
- OS: [e.g., Ubuntu 22.04]
- Docker Version: [e.g., 24.0.0]
- nself Version: [e.g., v0.2.0]

## Configuration
```
# Relevant config (remove passwords)
POSTGRES_PORT=5432
HASURA_PORT=8080
```

## Logs
```
# Error logs
[paste relevant error messages]
```

## Additional Context
Any other relevant information

Feature Requests

For feature requests, include:

  • Problem Statement: What problem does this solve?
  • Proposed Solution: How would you like it to work?
  • Use Case: Real-world scenario where this helps
  • Alternatives: Current workarounds or alternatives
  • Priority: How important is this to your project?

Questions and Help Requests

For general questions:

  • Context: What are you trying to accomplish?
  • What You've Tried: Solutions you've attempted
  • Specific Error: Exact error messages if any
  • Configuration: Relevant configuration details
  • Environment: Your setup details

Response Times and Expectations

Community Support

  • Response Time: 1-3 days typically, community-dependent
  • Best Effort: Volunteers helping when they can
  • Self-Service: Try documentation and diagnostics first
  • Patience: Allow time for thoughtful responses

Maintainer Support

  • Critical Bugs: Security issues and data loss bugs prioritized
  • Feature Requests: Evaluated based on community need and maintainer capacity
  • Pull Requests: Reviewed within 1-2 weeks typically
  • Documentation: Community contributions especially welcome

Professional Support

Consulting Services

Enterprise Support Available

For organizations needing dedicated support, we offer professional services:

  • 🎯 Architecture Consulting: Design review and optimization
  • πŸ”§ Custom Development: Tailored features and integrations
  • πŸ“ž Priority Support: Direct access with SLA guarantees
  • 🏫 Training: Team training and workshops
  • ☁️ Migration Services: Migrate from other platforms

Contact: enterprise@nself.org for pricing and availability

Contributing Back

Ways to Help the Community

The best way to get great support is to contribute to making nself better for everyone:

Answer Questions

Help other users in GitHub Discussions with problems you've solved.

Improve Documentation

Fix typos, add examples, or write guides for common use cases.

Report Issues

High-quality bug reports help improve nself for everyone.

Contribute Code

Submit pull requests for bug fixes and new features.

Recognition

Contributors are recognized through:

  • GitHub Contributors: Listed on the repository
  • Release Notes: Major contributions highlighted
  • Community Spotlight: Featured in project updates
  • Maintainer Path: Active contributors may become maintainers

Code of Conduct

Community Standards

The nself community follows these principles:

  • Respectful: Treat everyone with respect and kindness
  • Inclusive: Welcome people of all backgrounds and skill levels
  • Constructive: Focus on helping and improving
  • Patient: Remember everyone is learning
  • Collaborative: Work together toward common goals

Reporting Issues

If you experience harassment or inappropriate behavior, contact the maintainers at conduct@nself.org. All reports are handled confidentially.

Emergency Support

Critical Issues

Security Vulnerabilities

For security issues, please DO NOT post publicly. Contact security@nself.org directly with details.

Data Loss Prevention

If you're experiencing data loss:

  1. Stop all operations: Don't make changes that might worsen the situation
  2. Document the issue: Note exactly what happened and when
  3. Check backups: Look for recent backups you can restore from
  4. Seek immediate help: Post in GitHub Issues with "URGENT" tag

Support Channels Summary

ChannelBest ForResponse Time
DocumentationLearning, tutorials, referenceImmediate
FAQCommon questionsImmediate
GitHub DiscussionsQuestions, ideas, community1-3 days
GitHub IssuesBugs, feature requests1-7 days
Enterprise SupportProfessional servicesSLA-based

Next Steps

Ready to get the help you need?

The nself community is here to help you succeed. Don't hesitate to ask questions, report issues, or share your projects. Together, we make nself better for everyone.