Skip to content

Commit 7bb0dee

Browse files
committed
Add contributing guidelines to enhance project collaboration
1 parent 930a37e commit 7bb0dee

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

contributing.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Contributing
2+
3+
Thank you for considering contributing to this project! Here are some guidelines to help you get started:
4+
5+
## Code Structure
6+
7+
Please make sure to follow the existing code structure and organization. This helps maintain consistency and readability across the project.
8+
9+
## Testing
10+
11+
Ensure that all tests pass before submitting your changes. You can run the tests using the following command:
12+
13+
```sh
14+
go test ./...
15+
```
16+
17+
## Formatting
18+
19+
Make sure to format your code before committing. You can format your Go files using the following command:
20+
21+
```sh
22+
go fmt ./...
23+
```
24+
25+
## Pull Requests
26+
27+
When submitting a pull request, please include a clear description of the changes and the motivation behind them. Also, make sure to reference any relevant issues.
28+
29+
Thank you for your contributions!

0 commit comments

Comments
 (0)