Skip to content

Commit e09d4a9

Browse files
authored
Update README.md
1 parent 5d8082e commit e09d4a9

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,19 @@ Kalaam has it's own parser, interpreter and executes source code from parse tree
3535
- Feel free to play with project. Creative ideas are most welcome.
3636
- Use Kalaam Discord sever to connect with fellow contributors.
3737

38-
#` NOTE: MAKE SURE TO CREATE A PULL REQUEST ON 'dev-Kalaam-nextVersion' and NOT DIRECTLY ON THE MASTER BRANCH.`#
38+
#` NOTE: MAKE SURE TO CREATE A PULL REQUEST ON 'v1.2.0-dev' and NOT DIRECTLY ON THE MASTER BRANCH.`#
39+
40+
41+
## Steps to follow
42+
43+
1. Fork the repo
44+
2. create branch with the name of issue you want to fix. for e.g ```fixes whitespace issue while cleaning sourcecode```
45+
3. Run necessary tests using ```npm run test```. Add more test cases if you need to.
46+
4. Make sure your code is not breaking anything.
47+
5. Comment each line of your code. Write down why you are doing it instead of how you are doing it. Tell a story!
48+
6. Once you are ready, create a PR on current dev branch. DO NOT CREATE PR'S DIRECTLY ON MASTER BRANCH.
49+
7. Your code will be reviewed and if good, PR will be merged.
50+
8. Happy Contributing ⚙️
3951

4052

4153
## Future plans

0 commit comments

Comments
 (0)