Skip to content
Open
Changes from all commits
Commits
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
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,32 @@
# GoodFirstIssue

## How to Contribute

Contributions are welcome, including from first-time open-source contributors.

1. Read the existing README and `spec.md` to understand the project's intent before making changes.
2. Check the [Issues page](https://github.com/pranaykgupta/GoodFirstIssue/issues) for open tasks, and look for issues labeled `good first issue` if you're new to the project.
3. Fork the [repository](https://github.com/pranaykgupta/GoodFirstIssue).
4. Clone your fork:
```bash
git clone <your-fork-url>
cd GoodFirstIssue
```
5. Create a new branch off `master`:
```bash
git checkout -b your-branch-name
```
6. Make a focused change — avoid unrelated edits, and follow the existing code style in the file you're editing.
7. Run the test suite before committing:
```bash
npm test
```
8. Commit your changes with a clear, descriptive message:
```bash
git commit -m "Describe your change here"
```
9. Push your branch:
```bash
git push origin your-branch-name
```
10. Open a [Pull Request](https://github.com/pranaykgupta/GoodFirstIssue/pulls), briefly explaining what you changed and why.