First, thank you for intercepting our stream. We welcome contributors who are passionate about high-performance web architecture and futuristic design.
By contributing to BeyteFlow, you help us refine the flow of data across the modern web.
To ensure a seamless sync with our core systems, please follow these environmental requirements:
- Node.js:
v20.xor higher (LTS recommended) - Package Manager:
pnpm(preferred) ornpm - Editor: VS Code (recommended with ESLint & Prettier extensions)
We follow a strict Feature-Branch workflow to keep our main branch production-ready at all times.
- Synchronize: Ensure your local
mainis up to date. - Branch: Create a descriptively named branch:
feat/feature-name(New functionality)fix/glitch-name(Bug fixes)docs/update-manual(Documentation)perf/optimization(Performance tuning)
- Commit: Use Atomic Commits.
We use the Conventional Commits specification. This allows us to auto-generate changelogs and manage versioning.
Format: <type>(<scope>): <description>
- feat: A new "byte" of functionality.
- fix: Patching a leak in the flow.
- refactor: Code changes that neither fix a bug nor add a feature.
- chore: Updating build tasks, package manager configs, etc.
Example: feat(ui): add neon-glow animation to navbar buttons
Before submitting a Pull Request (PR), initiate the following diagnostics:
- Linting: Run
npm run lintto ensure code style compliance. - Build: Run
npm run buildto confirm the production bundle is stable. - Tests: Run
npm run test(if applicable) to ensure no regressions. - Documentation: Update READMEs if your changes introduce new logic.
When your code is ready for the stream:
- Open a PR against the
mainbranch. - Link the PR to a specific issue (e.g.,
Closes #42). - Provide a video/GIF for any UI/UX changes.
- Wait for a Core Maintainer to review and approve your bytes.
- Discord: Join our Dev-Terminal for real-time collaboration.
- GitHub Discussions: For architectural proposals and brainstorming.
- Security: If you find a vulnerability, please email
security@beyteflow.devinstead of opening a public issue.