Skip to content

Commit b01e2e2

Browse files
Mahi-korrapatimahi_korrapti
authored andcommitted
docs: add basic contributing guide
1 parent e1a5cf0 commit b01e2e2

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

docs/CONTRIBUTING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Contributing to quick-lint-js
2+
3+
Thank you for your interest in contributing to quick-lint-js!
4+
5+
## How to contribute
6+
7+
### 1. Fork the repository
8+
Create your own fork of the project on GitHub and clone it locally.
9+
10+
### 2. Create a new branch
11+
Use a descriptive branch name for your change:git checkout -b docs/update-contributing
12+
13+
14+
### 3. Make your changes
15+
For documentation updates, you can edit files inside the `docs/` directory or `README.md`.
16+
17+
### 4. Run tests (optional)
18+
If you modify source code, run tests:
19+
20+
### 5. Commit your changes
21+
22+
### 6. Push the branch
23+
24+
### 7. Open a Pull Request
25+
Go to your fork on GitHub and open a PR to the main repository.
26+
27+
---
28+
29+
If you have questions, feel free to open an issue or ask the maintainers. Thank you for helping improve quick-lint-js!
30+

0 commit comments

Comments
 (0)