Here's a clear and concise message you can send to your teammates:
Hey Team! 👋
Please follow these steps for making any code changes:
-
Pull the Latest Code:
git pull origin main
-
Create a New Branch for Your Task:
git checkout -b feature/your-task-name
-
Write Your Code:
Make your changes on this branch. -
Follow Commit Message Rules Using CommitLint:
- Commit Types: Use one of the following types:
feat
,fix
,docs
,style
,refactor
,perf
,test
,build
,ci
,chore
,revert
- Commit Message Format:
Example:
<type>: <Capitalized subject (max 72 chars)>
Feat: Add user authentication module Fix: Resolve login issue on mobile devices
- Additional Rules:
- Commit type must be lowercase (e.g.,
feat
,fix
). - The subject must start with a capital letter and follow sentence case.
- Subject line length should not exceed 72 characters.
- Ensure the subject is not empty.
- Commit type must be lowercase (e.g.,
- Commit Types: Use one of the following types:
-
Push Your Branch:
git add . git commit -m "Your Commit Message" git push origin feature/your-task-name
-
Create a Pull Request:
- Go to the GitHub repository.
- Create a Pull Request (PR) from your branch to
main
. - Ensure your changes are reviewed and approved.
- Direct pushes to the
main
branch are restricted. - All changes must go through a PR.
Let me know if you have any questions! 😊