Skip to content

Development Workflow

www0abdb-oss edited this page Sep 6, 2026 · 1 revision

Development Workflow

This page describes the development workflow used for the NexVaultX frontend.

Branches

NexVaultX uses separate branches for development and production.

main → prod → Production

main

The main branch is the primary development branch.

New features, improvements, fixes, and other changes should be developed and tested here before being released to production.

prod

The prod branch represents the production-ready version of the frontend.

Only changes that have been tested and are ready for release should be merged into prod.

Merging changes into prod triggers the production deployment.

Development Process

A typical development cycle looks like this:

  1. Start from the latest main branch.
  2. Create a branch for your change.
  3. Implement the change.
  4. Test the change locally.
  5. Run the project's checks.
  6. Commit your changes.
  7. Open a Pull Request targeting main.
  8. Review and address feedback.
  9. Merge the Pull Request into main.
  10. Once the changes are ready for production, merge them into prod.

Feature Branches

For larger changes, use a dedicated branch instead of working directly on main.

Example:

git checkout main
git pull
git checkout -b feature/example

Use descriptive branch names such as:

feature/project-page
fix/navbar-mobile
refactor/api-client
docs/contributing

Commits

Keep commits focused on a single change whenever possible.

Good examples:

Add project card component
Fix mobile navigation
Improve project page layout
Update documentation

Avoid vague commit messages such as:

changes
update
stuff
fix

Pull Requests

Pull Requests should:

  • Clearly describe the changes.
  • Explain why the changes were made when necessary.
  • Include relevant screenshots for UI changes.
  • Keep unrelated changes out of the PR.
  • Be tested before submission.

Testing

Before submitting a Pull Request, make sure the application:

  • Starts successfully.
  • Builds successfully.
  • Has no obvious runtime errors.
  • Works correctly on the affected pages.
  • Maintains the existing UI and functionality.

Run the project's available checks before submitting your changes.

Production Releases

Changes should not be pushed directly to the production branch unless they are intentionally being released.

The general release flow is:

Development
    ↓
main
    ↓
Testing & Review
    ↓
prod
    ↓
Production Deployment

Important Rules

  • Do not commit secrets or credentials.
  • Do not commit generated dependencies such as node_modules.
  • Avoid force-pushing shared branches.
  • Keep changes focused and reviewable.
  • Test changes before merging.
  • Follow the existing project conventions.

Related Pages

Clone this wiki locally