Skip to content

docs: add basic contributing guide #1246

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+30 −0
Open

docs: add basic contributing guide #1246

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Contributing to quick-lint-js

Thank you for your interest in contributing to quick-lint-js!

## How to contribute

### 1. Fork the repository
Create your own fork of the project on GitHub and clone it locally.

### 2. Create a new branch
Use a descriptive branch name for your change:git checkout -b docs/update-contributing


### 3. Make your changes
For documentation updates, you can edit files inside the `docs/` directory or `README.md`.

### 4. Run tests (optional)
If you modify source code, run tests:

### 5. Commit your changes

### 6. Push the branch

### 7. Open a Pull Request
Go to your fork on GitHub and open a PR to the main repository.

---

If you have questions, feel free to open an issue or ask the maintainers. Thank you for helping improve quick-lint-js!