docs: refresh README (automated audit)#1
Open
rustyorb wants to merge 1 commit into
Open
Conversation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideRefreshes the README with a more detailed, structured description of the 3I/ATLAS project, including background, contents, and contribution guidelines. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Pull request overview
Expands the repository README from a single-line placeholder into a short, structured overview describing the 3I/ATLAS topic, providing background context, and clarifying how to contribute.
Changes:
- Adds a brief description and background section for 3I/ATLAS and Avi Loeb’s paper.
- Adds “Contents” and “Contributing” sections to set expectations for repository usage.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # 3I-ATLAS | ||
| Avi Loeb paper about 3I/ATLAS | ||
|
|
||
| Notes and discussion on Avi Loeb's paper about 3I/ATLAS, the third confirmed interstellar object to pass through our solar system. |
|
|
||
| **3I/ATLAS** is the designation for the third interstellar object ever confirmed, following 1I/'Oumuamua (2017) and 2I/Borisov (2019). It was discovered by the ATLAS (Asteroid Terrestrial-impact Last Alert System) survey. | ||
|
|
||
| **Avi Loeb** is a Harvard astrophysicist known for his research into interstellar objects, including prior work on 'Oumuamua. His paper on 3I/ATLAS discusses the object's trajectory, physical properties, and possible origins. |
|
|
||
| ## Contributing | ||
|
|
||
| Notes, summaries, and relevant links can be added via pull request. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Automated README audit — please review the proposed README before merging.
Generated by [repo-readme-auditor].
Summary by Sourcery
Documentation: