Skip to content

Commit db04c2f

Browse files
updating readme 🔨
1 parent 0761861 commit db04c2f

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ easily with this pattern I've built!
99
- [Table of Contents](#table-of-contents)
1010
- [Installation](#installation)
1111
- [Usage](#usage)
12+
- [How to contribute](#how-to-contribute)
13+
- [Contribution guidelines](#contribution-guidelines)
1214
- [Contact](#contact)
1315

1416
## Installation
@@ -17,7 +19,7 @@ Run to install and use the project:
1719

1820
`npm install`
1921

20-
If you have any error during the test execution, run:
22+
If you have any error during the test execution, try to install manually and run:
2123

2224
`npm install -D typescript`
2325
`npm i ts-node`
@@ -32,6 +34,18 @@ After you install the depencencies you can use the command below to run the test
3234

3335
`npm test`
3436

37+
## How to contribute
38+
1. Fork the project
39+
2. Create a branch for your contribution: git checkout -b feature/your-feature
40+
3. Make your changes and commit: git commit -m 'Add amazing feature'
41+
4. Push to your fork: git push origin feature/your-feature
42+
5. Open a Pull Request to the main branch of the project
43+
44+
## Contribution guidelines
45+
46+
- Add tests for new features
47+
- Follow the existing code style
48+
3549
## Contact
3650

3751
If you're interested in finding out more, don't hesitate to contact me via linkedin!

0 commit comments

Comments
 (0)