Skip to content

Commit

Permalink
Adding contributing readme file (#31)
Browse files Browse the repository at this point in the history
  • Loading branch information
shkoubi authored Mar 3, 2024
1 parent 144fed3 commit f3c33b4
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Thank you for your interest and patience.
# 🤝 Contribute
Please refer to our [contributing guide](CONTRIBUTING.md) for more information on how to contribute!

0 comments on commit f3c33b4

Please sign in to comment.