Community
How to Report Bugs
Found a bug? Here's how to report it so we can fix it quickly.
Reporting Bugs Effectively
Good bug reports help us fix problems faster. Here's how to submit one that gets results.
Before You Report
Bug or Question?
First, let's figure out what you're dealing with:
- Need help using Antelopejs? → Ask in the forums instead
- Found something broken? → You're in the right place
Not sure? Start a chat in GitHub Discussions. If it turns out to be a bug, we can always convert it to an issue.
Check if It's Already Known
Save everyone some time:
- Look through open issues on GitHub
- Browse discussions for similar problems
- If someone already reported it, add your info to that thread instead
Search Tips
Try using exact error messages in your search. No luck? Try different words or phrases.
Creating a Great Bug Report
A helpful bug report needs three things: how to recreate the problem, what happened, and details about your setup.
1. Create a Simple Test Case
The most helpful thing you can provide is a simple example that shows the bug:
- Make a fresh project with just the basics
- Add only the code needed to show the problem
- Cut out anything unrelated
- Write down exactly how to trigger the bug
The best examples:
- Focus on just one issue
- Include minimal code
- Are easy for us to run
- Show the problem every time
2. Share Your Setup
Tell us about your environment:
| Information | How to Get It |
|---|---|
| Antelopejs version | Type ajs --version |
| Node.js version | Type node --version |
| Operating system | What OS and version you're using |
| Package manager | npm, yarn, or pnpm (with version) |
| Related dependencies | The important ones from package.json |
3. Tell Us What Happened
Clearly explain:
- What you were trying to do
- What you thought would happen
- What actually happened instead
- The exact error messages (text, not screenshots)
- Steps to make it happen again
Submitting Your Report
Once you've got everything ready:
- Head to Antelopejs issues
- Click "New Issue"
- Pick the "Bug Report" template
- Fill in all the sections with your info
- Include your test case or link to a repo
- Add screenshots only if they really help explain the issue
Report Template
**What's wrong?**
A simple description of the problem.
**How to see it**
Steps to make it happen:
1. Set up a project with '...'
2. Add this code '...'
3. Run this command '...'
4. See this error
**What I expected**
What should have happened instead.
**My setup**
- Antelopejs: v1.0.0
- Node.js: v16.14.0
- OS: Ubuntu 20.04
- Using: npm 8.3.0
**More info**
Anything else that might help.
After You Report
After you submit:
- Stay available for questions we might have
- Keep an eye on the issue as we look into it
- Try out fixes when we release them
- Be patient as we work through all reported issues
Security Issues
Found a security problem? That's different:
Don't post security bugs publicly. Instead, follow our security policy to report them privately.