Skip to content

Commit

Permalink
Add to reproduction logs for onboarding docs (#2180)
Browse files Browse the repository at this point in the history
  • Loading branch information
ErrenYeager authored Sep 3, 2023
1 parent 9f90a27 commit 0eb110b
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 2 deletions.
5 changes: 4 additions & 1 deletion docs/experiments-msmarco-doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -288,4 +288,7 @@ That's it!
+ Results reproduced by [@billcui57](https://github.com/billcui57) on 2023-05-14 (commit [`d82b6f7`](https://github.com/billcui57/anserini/commit/d82b6f76cbef009bccb0e67fc2bedc6fa6ae56c6))
+ Results reproduced by [@Richard5678](https://github.com/richard5678) on 2023-06-13 (commit [`4aeb3ef`](https://github.com/castorini/anserini/commit/4aeb3ef64738e780f710eaf2d0ed957bec4f6ede))
+ Results reproduced by [@pratyushpal](https://github.com/pratyushpal) on 2023-07-14 (commit [`17d5fc7`](https://github.com/castorini/anserini/commit/17d5fc7f338b511c4dc49de88e9b2ab7ea27f8aa))
+ Results reproduced by [@Mofetoluwa](https://github.com/Mofetoluwa) on 2023-08-04 (commit [`7314128`](https://github.com/castorini/anserini/commit/73141282b62979e189ac3c87d9a902064f34a1c5))
+ Results reproduced by [@Mofetoluwa](https://github.com/Mofetoluwa) on 2023-08-04 (commit [`7314128`](https://github.com/castorini/anserini/commit/73141282b62979e189ac3c87d9a902064f34a1c5))
+ Results reproduced by [@ErrenYeager](https://github.com/ErrenYeager) on 2023-09-02 (commit [`4ae518b`](https://github.com/castorini/anserini/commit/4ae518bb284ebcba0b273a473bc8774735cb7d19))


3 changes: 2 additions & 1 deletion docs/experiments-msmarco-passage.md
Original file line number Diff line number Diff line change
Expand Up @@ -427,4 +427,5 @@ The BM25 run with default parameters `k1=0.9`, `b=0.4` roughly corresponds to th
+ Results reproduced by [@Mofetoluwa](https://github.com/Mofetoluwa) on 2023-08-03 (commit [`7314128`](https://github.com/castorini/anserini/commit/73141282b62979e189ac3c87d9a902064f34a1c5))
+ Results reproduced by [@yilinjz](https://github.com/yilinjz) on 2023-08-24 (commit [`d4cb6fd`](https://github.com/castorini/anserini/commit/d4cb6fd1c0b5ed0a7eac4747af919823acc939fa))
+ Results reproduced by [@Andrwyl](https://github.com/Andrwyl) on 2023-08-26 (commit [`b64a412`](https://github.com/castorini/anserini/commit/b64a412453d0fee1b89179d3b665984651a8b8f8))
+ Results reproduced by [@UShivani3](https://github.com/UShivani3) on 2023-08-29 (commit [`24ab292`](https://github.com/castorini/anserini/commit/24ab292c5eaaccd40bbfa13fa7122eeb58261aaa))
+ Results reproduced by [@UShivani3](https://github.com/UShivani3) on 2023-08-29 (commit [`24ab292`](https://github.com/castorini/anserini/commit/24ab292c5eaaccd40bbfa13fa7122eeb58261aaa))
+ Results reproduced by [@ErrenYeager](https://github.com/ErrenYeager) on 2023-09-02 (commit [`4ae518b`](https://github.com/castorini/anserini/commit/4ae518bb284ebcba0b273a473bc8774735cb7d19))
34 changes: 34 additions & 0 deletions docs/reproduction-details.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Adding an Entry to the "Reproduction Log"

To contribute an entry to the "Reproduction Log" in a project's repository, follow these steps:

1. **Fork the Repository:**
- If you don't already have a fork of the project's repository, go to the repository on GitHub (or the platform it's hosted on).
- Click the "Fork" button. This will create a copy of the repository in your own GitHub account.

2. **Clone Your Fork:**
- Once you have your own fork, clone it to your local machine using Git.

3. **Edit the Reproduction Log:**

- Open the "Reproduction Log" file in a text editor. It should be located in the project's repository. The file are named like "experiments-msmarco-doc.md" and "start-here.md".

4. **Add an entry**
- Add your entry to the bottom of the "Reproduction Log" following the same format as the existing entries.
- Here's an example of how it should look:

```bash
Results reproduced by @YourUsername on yyyy-mm-dd (commit YourCommitID)

5. **Push Your Changes:**
- Push the changes to your fork on GitHub:

6. **Create a Pull Request (PR):**
- Go to your fork on GitHub and you should see a prompt to create a new pull request for the branch you just pushed.
- Click on it and follow the instructions to create the pull request.

7. **Submit the Pull Request:**
- Write a clear and concise description of your systme environment (Java, Python, Maven version and ...) in the pull request, and submit it. This will notify the project maintainers of your proposed changes.

8. **Wait for Review:**
- Project maintainers will review your pull request, and if everything looks good, they may merge it into the main repository.

0 comments on commit 0eb110b

Please sign in to comment.