Issues
Learn how to report issues and contribute to Nile Auth improvement
Before Reporting
Check Existing Issues
- Search the GitHub Issues and GitHub Discussions
- Review closed issues
- Check the documentation
Gather Information
- Nile Auth version
- Environment details
- Steps to reproduce
- Error messages
- Relevant logs
Creating an Issue
Issue Template
Issue Types
Bug Reports
- Describe the bug clearly
- Provide reproduction steps
- Include error messages
- Add relevant code snippets
Feature Requests
- Explain the use case
- Describe expected behavior
- Provide examples
- Consider alternatives
Documentation Issues
- Identify unclear sections
- Suggest improvements
- Point out errors
- Propose additions
Best Practices
Writing Good Issues
- Be specific and clear
- One issue per report
- Include relevant details
- Use proper formatting
Issue Labels
- bug: Bug reports
- enhancement: Feature requests
- documentation: Doc updates
- help wanted: Community assistance needed
- auth: Mark Nile Auth specific issues (not issues with the database, for instance)
Contributing Solutions
Fixing Issues
- Comment on the issue
- Fork the repository
- Create a fix
- Submit a pull request
Pull Request Guidelines
Security Issues
Responsible Disclosure
- DO NOT create public issues
- Email security@thenile.dev
- Wait for response
- Follow disclosure timeline
Security Guidelines
- Report vulnerabilities privately
- Provide proof of concept
- Allow time for fixes
- Follow up responsibly
Getting Help
Issue Lifecycle
- Submission
- Triage
- Investigation
- Resolution
- Closure
Best Practices
- Be respectful and professional
- Follow up on your issues
- Help others when possible
- Keep discussions focused