Blog API is a support structure that aims to provide the routes, data and other means of connection to achieve the Blog APP's functionality.
Demo API: https://backend-blog-ulzahk.vercel.app/
Demo Web App: https://frontend-blog-ulzahk.vercel.app/
- Using as reference Conventional Commits
- Every commit should have a sign with the contributor's GPG key
- The basic structure should be
[{ type in uppercase }] { description using imperative writing style or writing as a if it were a command }"
, for example:[UPDATE] header component with a new one more darker
- For the types we have:
[UPDATE]
: when we need to add a new feature, tests or change a property.[FIX]
: to implement the code necessary to fix a problem.[DELETE]
: when a file is going to be deleted and not replaced.[BREAKING CHANGE] or !
: to implement changes that are going to affect the integration with other services, for example:[UPDATE]! API version to v2 for new endpoints
- Create a new branch using as base the
dev
branch. - Do the necessary improvements and make a commit:
git commit -S -am "{commit message}"
or usegit add .
and thengit commit -S -m "{commit message}"
. - Upload changes to the repository:
git push origin <branch name>
. - Create a pull request to the
dev
branch. - Wait for the code review and the merge.
- Now your changes are in the dev environment.
- After a review your changes are going to be merged to the
master
branch. - For certain contributors there are exeptions to these steps.
Name | Link |
---|---|
Frontend Repository | https://github.com/Ulzahk/Frontend-Blog |
Postman Documentation: API Endpoints | https://documenter.getpostman.com/view/10957059/TVYJ5wod |
Blog APP | https://frontend-blog-ulzahk.vercel.app/ |