Welcome to the Lxisoft Standard Project Template!

This template repository is designed to ensure consistency, high traceability, and maintainability across all our software development projects. By using this template, you automatically inherit:

1. Standardized Epic, Feature, Story, and Task issue templates.
2. Mandatory Conventional Commit messages with issue ID linking.
3. Automated Semantic Versioning and Changelog generation.

LXISOFT

From nurturing a nascent idea to swiftly crafting a prototype, continuously delivering and launching into production, and providing ongoing upgrades, we are dedicated to assisting you every step of the way. Our team comprises internationally certified Java developers who possess the prowess to transform your concepts into fully functional web applications or cross-platform mobile apps for Android, iPhone, iPad, Windows, and more. Additionally, we excel in developing SOA/Microservices-based architectures and Java web portals.

Our Startups:

• DivisoSofttech
• Byta-Tech

Our Focus Areas:

• Software Development Activities: We utilize lean, agile methodologies (like the Epic-Feature-Story model) and BDD best practices to deliver robust, scalable, and user-centric software. Our core technology stack is broad and cloud-native, encompassing Java, Python, and Flutter for various development needs. We also leverage JavaScript/TypeScript with Node.js. Our foundational practices emphasize AI, 12 Factor Apps, Cloud, Container technologies, Kubernetes, and high-throughput Messaging Middleware for resilient deployment.

• Internship Program: We believe in nurturing the next generation of tech talent. Our comprehensive internship program offers hands-on experience, mentorship, and a direct pathway to full-time roles, fostering a culture of continuous learning and innovation.

Connect With Us:

This template uses Husky and Commitlint to automatically enforce commit message standards locally, and Standard-Version to manage releases.

After cloning your new repository from this template, run the following commands one time to install dependencies and activate the Git hooks:

npm install

This activates the 'commit-msg' hook on your local machine, enforcing commit rules.

All commits must follow the Conventional Commits format and reference an issue ID in the body.

Standard commit types (type-enum):

• feat
• fix
• docs
• style
• refactor
• perf
• test
• build
• ci
• chore
• revert

Recommended scopes (scope-enum):

• api, app, auth, build, ci, config, core, docs, deps, devops, feature, infra, model, service, test, ui, util, web, mobile
• Flutter: widget, screen, bloc, provider, theme, assets
• Java: controller, repository, entity, service, dto, spring, jpa
• TS/JS: component, hook, store, redux, context, types, eslint, webpack

How to create a commit:

• Use Commitizen for interactive commit messages:

npx cz

This project uses standard-version for automated releases:

1. Commit your changes using conventional commit messages.

2. Run the release command:

3. npx standard-version

4. What happens:

• The version in package.json is bumped (major, minor, or patch).
• A CHANGELOG.md is generated or updated.
• A new git commit and tag are created for the release.

4. Push your changes and tags:

git push --follow-tags

This repository uses two main branches:

• main: Stable production-ready code. Releases are tagged from here.
• developer: Active development. All new features, fixes, and changes are merged here first.

Recommended workflow:

1. Work on feature or fix branches, then merge into developer.
2. Regularly merge developer into main after review and testing.
3. Run the release process from the main branch:
   • Ensure all changes from developer are merged into main.
   • Run:

     npx standard-version
     git push --follow-tags
     

   • This will bump the version, update the changelog, and tag the release.
4. Optionally, create release branches (e.g., release/v1.0.0) for hotfixes or pre-release testing.

Summary:

• All development happens in developer.
• Only stable, reviewed code is merged to main and released.
• Releases are always tagged from main.

Recommended workflow:

1. Work on feature or fix branches, then merge into developer.
   • Create a new branch for your work:

     git checkout developer
     git pull
     git checkout -b feature/my-new-feature
     

   • After committing your changes, push and create a pull request to developer:

     git push origin feature/my-new-feature
     

2. Regularly merge developer into main after review and testing:
   • Merge changes from developer to main:

     git checkout main
     git pull
     git merge developer
     git push origin main
     

3. Run the release process from the main branch:
   • Ensure all changes from developer are merged into main.
   • Run:

     npx standard-version
     git push --follow-tags
     

   • This will bump the version, update the changelog, and tag the release.
4. Optionally, create release branches (e.g., release/v1.0.0) for hotfixes or pre-release testing:

   git checkout main
   git pull
   git checkout -b release/v1.0.0
   git push origin release/v1.0.0