Before Asking for Help
Before reaching out, try these steps:Check the Documentation
Review our comprehensive guides:
Search Existing Issues
Your question might already be answered:
- Browse GitHub Issues
- Check closed issues for resolved problems
- Search for keywords related to your issue
Support Channels
GitHub Issues
Best for:- Bug reports
- Feature requests
- Technical problems
- Build or setup issues
Create a new issue on GitHub with a clear title and detailed description.
- Clear title - Summarize the problem in one line
- Description - Explain the issue in detail
- Steps to reproduce - How to recreate the problem
- Expected behavior - What should happen
- Actual behavior - What actually happens
- Environment details:
- Node.js version (
node --version) - pnpm version (
pnpm --version) - Operating system
- Browser (if applicable)
- Node.js version (
- Screenshots - Visual issues benefit from images
- Code snippets - Relevant code that demonstrates the issue
- Error messages - Complete error logs
GitHub Discussions
Best for:- General questions
- Design discussions
- Feature ideas
- Community conversations
- Showing off your work
Start a discussion in the appropriate category for broader community engagement.
Pull Request Comments
Best for:- Questions about specific code changes
- Clarification on review feedback
- Implementation discussions
- Code-specific questions
Reporting Bugs
When you encounter a bug:1. Verify It's Actually a Bug
1. Verify It's Actually a Bug
Make sure the issue is reproducible:
- Clear your cache and try again
- Test in a fresh clone of the repository
- Verify your dependencies are up to date
- Check if it happens in different environments
2. Gather Information
2. Gather Information
Collect relevant details:
3. Create Minimal Reproduction
3. Create Minimal Reproduction
Simplify the problem:
- Remove unrelated code
- Isolate the specific component or feature
- Create a minimal example that shows the bug
- Test that the minimal example still reproduces the issue
4. Submit the Issue
4. Submit the Issue
Use this template:
Requesting Features
Have an idea for GitFolio?Check Existing Requests
Search issues and discussions to see if someone else has suggested the same feature.
Describe the Use Case
Explain:
- What problem does this solve?
- Who would benefit from this feature?
- How would it work from a user perspective?
- Are there examples of this in other projects?
Propose Implementation (Optional)
If you have technical ideas:
- How could this be implemented?
- What changes would be needed?
- Are there any technical challenges?
- Would you be willing to contribute the implementation?
Getting Code Review Help
If you’re stuck during code review:Understand the Feedback
Understand the Feedback
If review comments are unclear:
- Ask for clarification directly in the PR
- Request specific examples
- Ask about the reasoning behind suggestions
- Be respectful and open to learning
Request Additional Review
Request Additional Review
If you’re unsure about changes:
- Make your best attempt at addressing feedback
- Comment on what you’re uncertain about
- Ask for a second opinion
- Request a re-review when ready
Learn from Examples
Learn from Examples
Look at merged PRs:
- Find similar changes that were accepted
- Study how feedback was addressed
- Learn from successful contributions
- Apply those patterns to your work
Community Guidelines
When seeking support:Be Respectful
- Treat everyone with kindness and respect
- Assume good intentions
- Be patient - maintainers and contributors are volunteers
- Thank people for their help
Be Clear
- Use descriptive titles
- Provide complete information
- Format code with syntax highlighting
- Use screenshots when helpful
Be Patient
- Responses may take time
- Maintainers have other commitments
- Don’t bump issues immediately
- Follow up politely if needed
Be Collaborative
- Share solutions you find
- Help others when you can
- Contribute back to the community
- Document your learnings
Common Issues & Solutions
Installation Problems
Installation Problems
Issue: Dependencies won’t installSolutions:
Build Failures
Build Failures
Issue: Build fails with errorsSolutions:
Dev Server Issues
Dev Server Issues
Issue: Dev server won’t startSolutions:
- Check if port 3000 is in use
- Verify environment variables
- Check console for errors
- Try killing all Node processes and restarting
Hot Reload Not Working
Hot Reload Not Working
Issue: Changes don’t reflect in browserSolutions:
- Hard refresh browser (Cmd/Ctrl + Shift + R)
- Restart dev server
- Clear browser cache
- Check if you’re editing the correct file
- Verify file watchers aren’t maxed out (Linux)
TypeScript Errors
TypeScript Errors
Issue: Type errors in your codeSolutions:
- Import types from
@workspace/types - Check TypeScript documentation
- Look at existing templates for examples
- Use proper type annotations
- Don’t use
any- use specific types
Response Time Expectations
Typical response times:- GitHub Issues - Usually within a few days
- Pull Requests - Initial review within a week
- Discussions - Community responses may vary
- Critical bugs - Higher priority, faster response
All maintainers and contributors are volunteers. Please be patient and understanding with response times.
Contributing to Support
Help others in the community:- Answer questions in discussions
- Help troubleshoot issues
- Review pull requests
- Improve documentation
- Share your experiences
Emergency Contact
For urgent security issues:Do NOT report security vulnerabilities in public issues. Contact the maintainers privately through GitHub or the email in the repository.
Additional Resources
- Repository: github.com/Skb3611/GitFolio
- Website: gitfolio.in
- License: MIT License
- Maintainer: Shubham Bhilare
Get Involved
The best way to get support is to be part of the community:- Star the repository on GitHub
- Watch for updates and discussions
- Participate in conversations
- Share your templates and experiences
- Help other contributors