Skip to content

Commit ce38fb2

Browse files
author
nirajgiriXD
committedDec 29, 2023
add: workflow description
1 parent 9e22f25 commit ce38fb2

File tree

1 file changed

+79
-0
lines changed

1 file changed

+79
-0
lines changed
 

‎WORKFLOW.md

+79
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# Workflow
2+
3+
1. Create a New Branch:
4+
5+
- Create a new branch from the default branch (main):
6+
7+
```bash
8+
git checkout main
9+
git pull origin main
10+
git checkout -b feat/your-feature-name
11+
```
12+
13+
- Replace `your-feature-name` with a descriptive name for your new feature.
14+
15+
Alternatively, for fixing an issue:
16+
17+
```bash
18+
git checkout main
19+
git pull origin main
20+
git checkout -b fix/your-issue-name
21+
```
22+
23+
- Replace `your-issue-name` with a descriptive name for your issue.
24+
25+
2. Branch Naming Conventions:
26+
27+
- Ensure that branch names do not contain any capital letters.
28+
- For adding a new feature, the branch name should start with `feat/` followed by the feature name.
29+
- For fixing an issue, the branch name should start with `fix/` followed by the issue name.
30+
31+
3. Work on the Feature or Fix:
32+
33+
- Implement your feature or fix in the newly created branch.
34+
- Make sure to commit your changes regularly.
35+
36+
4. Pull Latest Changes:
37+
38+
- Before creating a new branch or raising a pull request (PR), pull the latest changes from the remote repository:
39+
40+
```bash
41+
git checkout main
42+
git pull origin main
43+
```
44+
45+
5. Create a Pull Request:
46+
47+
- Once your feature or fix is ready, push the branch to the remote repository:
48+
49+
```bash
50+
git push origin feat/your-feature-name
51+
```
52+
53+
or
54+
55+
```bash
56+
git push origin fix/your-issue-name
57+
```
58+
59+
- Create a pull request on the GitHub repository. Ensure that the pull request is targeting the main branch.
60+
61+
6. Pull Request Review:
62+
63+
- The main branch is protected, so all changes must go through a pull request.
64+
- A reviewer will be assigned to review and approve the pull request.
65+
- Make any necessary changes based on the reviewer's feedback.
66+
67+
7. Merge to Main:
68+
69+
- Once the pull request is approved, it can be merged into the main branch.
70+
71+
8. Repeat as Needed:
72+
73+
- Repeat the process for adding new features or fixing issues by creating new branches and pull requests.
74+
75+
## Note:
76+
77+
- Follow these steps consistently to maintain a clean and organized version history.
78+
- Regularly pull the latest changes from the remote main branch to avoid conflicts.
79+
- Adhere to branch naming conventions for clarity and consistency in the version history.

0 commit comments

Comments
 (0)
Please sign in to comment.