Skip to content

Commit e2c10b6

Browse files
committed
docs: add contribution guidelines
1 parent 5e782c1 commit e2c10b6

File tree

1 file changed

+63
-0
lines changed

1 file changed

+63
-0
lines changed

CONTRIBUTION.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Contribution Guide
2+
3+
Thank you for your interest in contributing to our project! We welcome contributions from the community to help make this project better. Here are some ways you can contribute:
4+
5+
## How to Contribute
6+
7+
### Bug Fixes and Features
8+
9+
- You can contribute to this project by:
10+
- Fixing bugs in the codebase.
11+
- Implementing new features or enhancements.
12+
13+
### Problem Solving
14+
15+
- Contribute to problem-solving efforts by:
16+
- Resolving bugs or issues.
17+
- Completing tasks or problems.
18+
- Adding or improving problem descriptions.
19+
20+
### Testing
21+
22+
- Help improve the quality of our project by:
23+
- Fixing or adding tests to ensure code reliability.
24+
25+
## Getting Started
26+
27+
To get started with contributing, follow these steps:
28+
29+
1. Fork the repository on GitHub.
30+
31+
2. Clone your forked repository to your local machine:
32+
33+
```bash
34+
git clone https://github.com/bujosa/leetcode-challenges-in-rust.git
35+
```
36+
37+
3. Create a new branch for your changes:
38+
39+
```bash
40+
git checkout -b branch-name
41+
```
42+
43+
4. Make your changes to the codebase.
44+
45+
using conventional commits
46+
47+
```bash
48+
git add . && git commit -m "feat: add new feature"
49+
```
50+
51+
or
52+
53+
```bash
54+
git add . && git commit -m "fix: fix bug"
55+
```
56+
57+
5. Push your changes to your forked repository:
58+
59+
```bash
60+
git push origin branch-name
61+
```
62+
63+
6. Submit a pull request to the `main` branch of the repository.

0 commit comments

Comments
 (0)