Skip to main content

Contributing to AxCom

Welcome! We are excited that you want to contribute to AxCom. Whether you are reporting a bug, proposing a feature, improving documentation, or fixing code, your help makes this project better.

Contribution Pathways​

We welcome contributions across several areas:

🐛 Issue Reporting & Feedback​

  • If you find a bug, please search existing issues to see if it is already known. If not, open a bug report.
  • If you have questions or want to discuss ideas, join the conversation in GitHub Discussions.

📖 Documentation​

  • Clarifying concepts, fixing typos, and updating API documents is highly appreciated.
  • Documentation markdown files are located in the docs folder.
  • You can preview changes locally by building the Docusaurus site inside the axcom-engine-docs-site directory.

💻 Code Contributions​

  • We accept pull requests for bug fixes, performance improvements, and new features.
  • Make sure to review the GitHub PR Checklist.

Quick Resources​