From 8af6e25d1aeb1b5ce904ae9a3a4d17c9b2efb6af Mon Sep 17 00:00:00 2001 From: SHRISHTI TIWARI Date: Mon, 24 Aug 2026 17:21:10 +0530 Subject: [PATCH] Add How to Contribute section to README --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index 4ab3c605..69c910cc 100644 --- a/README.md +++ b/README.md @@ -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 + 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.