Getting Help

Getting Support

Stuck on something? No worries - there are plenty of ways to get help with Antelopejs. This guide will show you where to ask questions and how to get the best answers.

Where to Get Help

GitHub Discussions

The main place to ask questions is our GitHub Discussions forum. It's perfect for:

• Asking detailed technical questions
• Suggesting new features
• Sharing what you've built
• Talking with other developers

To use it:

1. Go to the Discussions page
2. Check if someone already asked your question
3. Click "New discussion" if you need to create a new topic

Discord Chat

For quick help, join our Discord server where you can:

• Chat with the developers
• Get fast answers to simple questions
• Join community events
• Meet other Antelopejs users

Other Places

• Stack Overflow: Tag your question with antelopejs on Stack Overflow
• Twitter: Follow @antelopejs for news and updates

How to Ask Good Questions

Follow these tips to get better answers, faster:

1. Give the Full Picture

Don't just say what's broken - explain:

• What you're trying to build
• How you're trying to do it
• What you've already tried
• Show your relevant code

2. Do a Little Research

Before asking:

• Check the docs
• Search through old discussions
• Try debugging it yourself
• Look at examples

3. Share a Simple Example

When showing code:

• Keep it short - just the relevant parts
• Format it properly in code blocks
• Include the exact error messages as text
• Tell us your versions (Node.js, Antelopejs, OS)

4. Be Clear About the Problem

Compare these:

❌ "It's not working!"

✅ "When I run ajs project run, I get this error: Error: Cannot find module 'example'"

Common Issues

Module Loading Problems

If your modules aren't loading:

• Double-check your antelope.json file
• Make sure you've imported all needed interfaces
• Check version compatibility
• Look for path problems

Interface Issues

If interfaces aren't working:

• Check your folder structure follows interfaces/[name]/[version]/
• Make sure you've implemented all required methods
• Check your TypeScript types
• Verify you've connected everything with ImplementInterface

Help Improve Antelopejs

Report Bugs

Found a bug?

1. Check if someone already reported it
2. Create a simple test case that shows the problem
3. Follow our bug reporting guide

Improve the Docs

Spot something confusing or missing in the docs?

• For small fixes: Edit the page on GitHub
• For bigger changes: Open an issue explaining what needs improvement