Skip to content

Commit 2ec105c

Browse files
committed
added contributors guidline ✌️
1 parent 30fa3f5 commit 2ec105c

File tree

3 files changed

+31
-1
lines changed

3 files changed

+31
-1
lines changed

.npmignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@ src
22
test
33
.github
44
.gitignore
5-
TODO.md
5+
TODO.md
6+
CONTRIBUTING.md

CONTRIBUTING.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
## Before You Contribute
2+
3+
### Raise an Issue First
4+
Before you invest a significant amount of time on a change, please create a issue describing your proposal. This will help us to make sure that the change is in line with the project's goals, roadmap and avoid duplicate work.
5+
6+
### Avoid Dependencies
7+
We want to keep the project as lightweight as possible. So, please avoid adding any new dependencies unless it's absolutely necessary.
8+
9+
---
10+
11+
## Contributing
12+
13+
- Fork the repository on GitHub to your personal account.
14+
- Clone your forked repository to your local development environment.
15+
- Create a new branch for your feature or bug fix: ```git checkout -b your-branch-name```
16+
- Install the project dependencies: ```pnpm i```
17+
- Run the project in development mode: ```pnpm dev```
18+
- Make changes to your local repository.
19+
- Commit your changes and push them to your forked repository.
20+
- Open a pull request from your forked repository to the **dev branch** of this repository.
21+
22+
## Code Licensing
23+
24+
Your contributions are subject to the project's open-source(MIT) license. By submitting a PR, you agree to release your code under this license.
25+
26+
## Thanks for your contribution!

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,3 +91,6 @@ console.log(resp);
9191
- [ ] IS NULL
9292
- [ ] IS NOT NULL
9393
- [ ] Typescript Support
94+
95+
## Contributing
96+
Read the [contributing guide](./CONTRIBUTING.md) to learn how you can contribute to this project.

0 commit comments

Comments
 (0)