Contributing
Thank you for your interest in contributing to nodebuilder-xd!
Your feedback, ideas, and pull requests help make this project stronger for everyone.
Ways to Contribute
You can contribute by:
- Reporting bugs or issues you encounter
- Suggesting new features or improvements
- Submitting pull requests with code fixes or documentation updates
- Helping review and test open pull requests
Reporting Issues
If you find a bug or want to suggest an enhancement, open an issue on GitHub:
When reporting, please include:
- Steps to reproduce the issue
- Expected vs actual behavior
- Node.js version and OS details
[!TIP] Clear, reproducible issue reports speed up debugging and fixes.
Submitting Pull Requests
Follow these steps when submitting a PR:
-
Fork the repository.
-
Create a new branch for your change:
git checkout -b fix-crud-bug -
Make your changes following the existing code style.
-
Test locally before submitting.
-
Submit a pull request with a clear title and description.
[!NOTE] Keep PRs focused — one feature or fix per pull request is best.
Running the Project Locally
Clone the repo and install dependencies:
git clone https://github.com/codewithevilxd/nodebuilder-xd.git
cd nodebuilder-xd/backend
npm install
npm linkThen test the CLI locally:
nodebuilder-xdThis runs your linked version globally so you can test live changes.
✅ Contribution Guidelines
- Write clean, consistent code (follow existing patterns)
- Include helpful comments and meaningful commit messages
- Keep templates self-contained — no external dependencies
- Update documentation if your changes affect the CLI or templates
Community
Have questions or want to collaborate? Join the discussion via:
- GitHub Discussions
- Future community Discord (coming soon)
Every contribution — big or small — helps nodebuilder-xd grow. Even typo fixes or doc updates are valuable! Thank you for being part of this journey! 🚀