Contributing to NexoralDNS
Thank you for your interest in NexoralDNS! We appreciate your support and feedback.
â ī¸ Important Notice
NexoralDNS is source-available proprietary software, not open source.
This means:
- â You can view the source code
- â You can report bugs and issues
- â You can suggest features
- â You can help improve documentation
- â Code contributions (pull requests) are NOT accepted
- â Modifications to the source code are NOT permitted
How You Can Contribute
Even though we don't accept code contributions, there are many valuable ways you can help improve NexoralDNS:
1. Report Bugs
Found a bug? We want to know! Please help us by:
- Check existing issues first to avoid duplicates
- Create a new issue with the "Bug Report" template
- Provide detailed information:
- NexoralDNS version (found in dashboard or
VERSIONfile) - Operating system and version
- Steps to reproduce the bug
- Expected behavior vs actual behavior
- Error messages or logs (if any)
- Screenshots (if applicable)
- NexoralDNS version (found in dashboard or
Example of a Good Bug Report:
Title: DNS queries fail for custom domains after restart Environment: - NexoralDNS version: 1.2.3 - OS: Ubuntu 22.04 LTS - Docker version: 24.0.5 Steps to reproduce: 1. Create custom domain "app.local" pointing to 192.168.1.100 2. Restart NexoralDNS using `docker compose restart` 3. Query the domain using `dig app.local` Expected: Should resolve to 192.168.1.100 Actual: Returns NXDOMAIN error Error logs: [paste relevant logs here]
2. Suggest Features
Have an idea to make NexoralDNS better? We'd love to hear it!
- Check existing feature requests to see if it's already suggested
- Create a new issue with the "Feature Request" template
- Describe your use case:
- What problem does this solve?
- Who would benefit from this feature?
- How should it work?
- Any alternative solutions you've considered?
We prioritize features based on:
- Number of users requesting it
- Alignment with product vision
- Technical feasibility
- Premium vs free tier strategy
3. Improve Documentation
Found a typo, unclear instructions, or missing documentation?
- Create an issue describing what's wrong or missing
- Suggest improvements for documentation sections
- Report broken links or outdated information
We review all documentation feedback and update accordingly.
4. Report Security Vulnerabilities
DO NOT report security vulnerabilities as public issues!
Please see our Security Policy for responsible disclosure procedures.
5. Help Other Users
- Answer questions in GitHub issues
- Share your experience and solutions
- Help troubleshoot problems others are facing
- Provide helpful information in discussions
6. Spread the Word
- Star the repository on GitHub
- Share NexoralDNS with others who might find it useful
- Write blog posts or tutorials about your use case
- Provide feedback on your experience
Issue Guidelines
Before Creating an Issue
- Search existing issues to avoid duplicates
- Ensure you're using the latest version
- Check the troubleshooting section
- Gather relevant information (version, OS, logs, etc.)
Issue Etiquette
- Be respectful and professional in all interactions
- Provide context - help us understand your situation
- Be patient - we review all issues but may take time to respond
- Follow up - respond to questions and provide updates
- Close resolved issues - let us know when your problem is fixed
Issue Labels
We use the following labels to organize issues:
| Label | Description |
|---|---|
bug | Something isn't working correctly |
feature-request | New feature or enhancement suggestion |
documentation | Documentation improvements |
question | General questions about usage |
duplicate | Issue already reported |
wontfix | Not planned for implementation |
investigating | Under review by maintainers |
priority | High-priority issues |
What Happens After You Report?
Bug Reports
- We'll review and attempt to reproduce
- May ask for additional information
- Will update the issue with findings
- Fix will be included in a future release
- Issue will be closed when fix is deployed
Feature Requests
- We'll evaluate the request
- May ask clarifying questions
- Will label as
feature-request - May be marked for future releases or declined
- Premium features go to premium customers first
Why No Code Contributions?
We understand this may be different from traditional open source projects. Here's why:
- Commercial Product: NexoralDNS is a commercial product with free and premium tiers
- Code Quality Control: Ensures consistent code quality and architecture
- Support Obligations: We're responsible for supporting all features
- Intellectual Property: Protects our proprietary technology and business model
- Rapid Development: Allows us to move quickly without PR review overhead
However, your feedback is invaluable! Many features and improvements come directly from user suggestions and bug reports.
Paid Support & Custom Development
Need custom features or priority support?
- Premium License: Includes priority support - nexoral.in
- Enterprise Support: Custom SLAs and dedicated support available
- Custom Development: Contact us for bespoke features and integrations
Visit nexoral.in or email us for more information.
Recognition
While we don't accept code contributions, we value all contributions:
- Bug reporters who help us improve stability
- Feature requesters who shape our roadmap
- Community helpers who assist other users
- Documentation improvers who make NexoralDNS easier to use
Thank you for being part of the NexoralDNS community!
Questions?
- đ Check the README for basic information
- đ See Troubleshooting guide
- đŦ Open a GitHub issue for questions
- đ Visit nexoral.in for commercial inquiries