Contributing to XyPriss
First off, thank you for considering contributing to XyPriss! It's people like you who make XyPriss such a powerful tool for the developer community.
XyPriss is an ambitious project that bridges the gap between Rust's performance and Node.js's productivity. Whether you're fixing a bug, improving documentation, or proposing a new feature, your help is welcome.
How Can I Contribute?
🌟 Star the Project
The simplest and most impactful way to support XyPriss is to Star the repository on GitHub. It helps increase the project's visibility and shows us that the community values our work.
🐛 Reporting Bugs
Before creating a bug report, please check the existing issues to see if the problem has already been reported. When reporting a bug, include:
- A clear, descriptive title.
- Steps to reproduce the issue.
- Expected vs. actual behavior.
- Your environment (OS, Node.js version, Bun version).
💡 Feature Requests
We're always looking for ways to make XyPriss better. If you have an idea for a feature, please open an issue and describe:
- The problem this feature would solve.
- How you imagine the feature working.
- Any alternative solutions you've considered.
📝 Improving Documentation
Good documentation is key to a great developer experience. If you find a typo, a confusing explanation, or think a guide could be improved, feel free to submit a Pull Request.
🛠️ Code Contributions
If you want to contribute code:
- Fork the repository.
- Clone your fork locally.
- Create a Branch for your changes.
- Write your code and Tests.
- Ensure the project builds successfully.
- Submit a Pull Request with a clear description of your changes.
Development Setup
To work on XyPriss locally, you'll need:
- Rust (latest stable)
- Node.js (v18+)
- Bun (latest)
- xfpm (for package management)
# Install dependencies
xfpm install
# Run in development mode
npm run dev
Community
Join our community to discuss features, ask questions, and connect with other XyPriss developers:
- GitHub Discussions: Join the conversation
- Discord: [Coming Soon]
Thank you for being part of the XyPriss journey! 🚀