Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation for YoMo #985

Merged
merged 1 commit into from
Jan 2, 2025
Merged

Conversation

fanweixiao
Copy link
Member

@fanweixiao fanweixiao commented Jan 2, 2025

Update docs/README.md to include contribution guidelines.

  • Contributing Section
    • Add a new section titled "Contributing" with steps for contributing to the YoMo documentation.
    • Include guidelines for making clear and concise changes, following the existing structure, testing changes locally, and providing detailed descriptions in pull requests.

For more details, open the Copilot Workspace session.

Update `docs/README.md` to include contribution guidelines.

* **Contributing Section**
  - Add a new section titled "Contributing" with steps for contributing to the YoMo documentation.
  - Include guidelines for making clear and concise changes, following the existing structure, testing changes locally, and providing detailed descriptions in pull requests.

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/yomorun/yomo?shareId=XXXX-XXXX-XXXX-XXXX).
Copy link

vercel bot commented Jan 2, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment
Name Status Preview Updated (UTC)
yomo ⬜️ Ignored (Inspect) Visit Preview Jan 2, 2025 1:47am

@fanweixiao fanweixiao self-assigned this Jan 2, 2025
@fanweixiao fanweixiao requested a review from woorui January 2, 2025 01:47
@fanweixiao fanweixiao added the doc Improvements or additions to documentation label Jan 2, 2025
Copy link

codecov bot commented Jan 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 46.88%. Comparing base (1dd203a) to head (be29423).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #985      +/-   ##
==========================================
+ Coverage   46.22%   46.88%   +0.65%     
==========================================
  Files          97       97              
  Lines        6721     6721              
==========================================
+ Hits         3107     3151      +44     
+ Misses       3413     3371      -42     
+ Partials      201      199       -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@fanweixiao fanweixiao merged commit 00705f3 into master Jan 2, 2025
5 of 6 checks passed
@fanweixiao fanweixiao deleted the fanweixiao/improve-docs branch January 2, 2025 01:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants