From f3c33b40d3a5da9315c6d02adaebfb5506b7758d Mon Sep 17 00:00:00 2001
From: Sharon K <36400533+shkoubi@users.noreply.github.com>
Date: Sun, 3 Mar 2024 13:25:03 +0200
Subject: [PATCH] Adding contributing readme file (#31)

---
 CONTRIBUTING.md | 11 +++++++++++
 README.md       |  7 ++++++-
 2 files changed, 17 insertions(+), 1 deletion(-)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..7aa3298
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,11 @@
+# Contribute to *NOTSOFAR1*
+Our repository is read-only, so there are a few steps required to push your code into it:
+
+1. **Fork the Repository**: Users who want to contribute should fork the repository to their own GitHub account.  
+1. **Make Changes**: Make changes to the forked repository.  
+1. **Create a Pull Request**: After making changes, create a PR to propose your changes to *NOTSOFAR1*. Do this by:
+   - Navigating to the forked repository.
+   - Clicking on the "Pull Requests" tab, and then clicking the "New Pull Request" button.
+   - You will then be able to select **your forked repository** and the branch you want to merge changes into `NOTSOFAR1/main`.
+1. **Submit the PR**: Fill out the PR form, providing details about the changes you have made. Once ready, submit the PR.
+1. **Review and Merge**: One of the *NOTSOFAR1* team members will review the PR, provide feedback, and eventually merge it into the main repository if the changes are deemed appropriate.
diff --git a/README.md b/README.md
index 90d3b65..bdfb1eb 100644
--- a/README.md
+++ b/README.md
@@ -268,4 +268,9 @@ This public data is currently licensed for use exclusively in the NOTSOFAR chall
 We appreciate your understanding that it is not yet available for academic or commercial use. 
 However, we are actively working towards expanding its availability for these purposes. 
 We anticipate a forthcoming announcement that will enable broader and more impactful use of this data. Stay tuned for updates. 
-Thank you for your interest and patience.
\ No newline at end of file
+Thank you for your interest and patience.
+
+
+# 🤝 Contribute
+
+Please refer to our [contributing guide](CONTRIBUTING.md) for more information on how to contribute!
\ No newline at end of file