desciption of libname
npm install vizor_alerts
Lib template for the VIZOR ENGINE PLATFORM
FIRST TIME :
1. Clone the project:
git clone https://github.com/your-username/your-repository.git
NOTA : Al clonar el template y crear una nueva libreria
usar rm -rf .git
para desvincular el proyecto
y crear otro repositorio en github.
2. Modify:
Make your changes in the codebase.
3. Create a local branch:
- NOTA : Como nombre del branch se puede usar la versión,
ejemplo : release-vX.Y.Z
Colocar en CHANGELOG.md el detalle de los cambios realizados:
``bash``
git checkout -b feature-branch-name
4. Add and commit changes:
git add .
git commit -m "Description of the changes"
5. Push the branch:
git push origin feature-branch-name
6. Create a pull request on GitHub.
7. Ask the owner to accept and merge
NEXT STEPS (Continous Development)
1. pull to have the lastest changes
git checkout main
git pull origin main
2. create a new branch (use a name that clearly comunicate the featur you ar working on)
git checkout -b new-feature-branch
3. Make your changes in the codebase.
4. push the new changes
git add .
git commit -m "Description of changes"
git push origin new-feature-branch
Determine the version update type:
Decide whether the changes constitute a major, minor, or patch update based on the Semantic
Versioning guidelines:
Major: Incompatible API changes.
Minor: Backward-compatible functionality.
Patch: Backward-compatible bug fixes.
Update the version number:
Update the version number in the relevant files (e.g., package.json for Node.js projects) based on the determined version update type.
1. Create a release branch:
git checkout main
git pull origin main
git checkout -b release-vX.Y.Z
Update the changelog:
Document the changes in a CHANGELOG.md file, outlining the new features, bug fixes, and other relevant information for the release.
2. Commit the version update and changelog:
git add .
git commit -m "Bump version to vX.Y.Z and update changelog"
3. Push the release branch:
git push origin release-vX.Y.Z
4. Create a pull request for the release branch:
5. Create a pull request to merge the release branch into the main branch.
6. Merge the pull request:
Once reviewed and approved, merge the pull request.
7. Tag the release:
8. After merging, create a tag for the new release:
git checkout main
git pull origin main
git tag -a vX.Y.Z -m "Release version vX.Y.Z"
git push origin vX.Y.Z
9. Create a release on GitHub:
Go to the GitHub repository, navigate to the "Releases" section, and create a new release using the created tag. Provide the release notes based on the changelog.
By following these steps, you'll maintain a well-organized versioning system, ensuring that the codebase remains structured and that changes are properly documented and released.