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

Modify contributing md scripts to solve conflicts between doc and scripts #2107

Merged
merged 4 commits into from
Aug 5, 2024

Conversation

tiruka
Copy link
Contributor

@tiruka tiruka commented Aug 5, 2024

Pull Request Template

Checklist

  • Confirmed that run-checks all script has been executed.
  • Made sure the book is up to date with changes in this PR.

Related Issues/PRs

Fixes #2106

Changes

1.no_std is typo, but it should be no-std

no_std is typo, but it should be no-std

The doc tell that there are only two environment of std and no-std, but it now includes four environments due to script.

% ./run-checks.sh no_std
    Finished `dev` profile [optimized] target(s) in 0.16s
     Running `target/debug/xtask run-checks no_std`
error: invalid value 'no_std' for '<ENV>'
  [possible values: all, std, no-std, typos, examples]

  tip: a similar value exists: 'no-std'

For more information, try '--help'.

2.environment values

“If no environment value has been passed, run both std and no_std checks”, this is incorrect because when I use the script without environment args, it causes an error as follow.

% ./run-checks.sh       
    Finished `dev` profile [optimized] target(s) in 0.15s
     Running `target/debug/xtask run-checks`
error: the following required arguments were not provided:
  <ENV>

Usage: xtask run-checks <ENV>

It is because the implementation and docs are different. As of now, I believe script comments are correct and modify the codes by modifying default value so as to keep All as it is and executes checks except examples. But if you prefer to others, I will follow it, so please let me know.

3.torch installation.
I got in trouble when executing ./run-checks.sh all because I have never installed torch on my pc. It is because ./run-checks.sh all executes crates/burn-tch and it requires torch installation. Therefore, adding the link of crates/burn-tch will definitely help developers like me to solve the issue, so I added the link on the CONTRIBUTING.md.

Testing

I run ./run-check.sh and checked out All is executed.

@tiruka tiruka marked this pull request as draft August 5, 2024 05:52
Copy link

codecov bot commented Aug 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.23%. Comparing base (f7639bd) to head (5b38464).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2107   +/-   ##
=======================================
  Coverage   86.23%   86.23%           
=======================================
  Files         688      688           
  Lines       88465    88465           
=======================================
  Hits        76285    76285           
  Misses      12180    12180           

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

@tiruka tiruka marked this pull request as ready for review August 5, 2024 06:41
Copy link
Collaborator

@antimora antimora left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Thanks for improving the script and documentation!

@antimora antimora merged commit a53f459 into tracel-ai:main Aug 5, 2024
14 checks passed
@tiruka tiruka deleted the modify-contributing-md-script branch August 6, 2024 00:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Conflicts bewteen Contributing.md and scripts
2 participants