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

Update CONTRIBUTING.md post-repo-split #1564

Merged
merged 21 commits into from
Jan 20, 2025
Merged

Conversation

lockshaw
Copy link
Collaborator

@lockshaw lockshaw commented Dec 27, 2024

Description of changes:

Update docs post-repo split, especially the developer/setup docs in CONTRIBUTING.md.

Also aggressively remove a whole bunch of outdated files. Remember that these are all available in the archived master and inference branches, as well as in the git history.

Related Issues:

Linked Issues:

Issues closed by this PR:

  • Closes #

This change is Reviewable

@lockshaw lockshaw marked this pull request as ready for review January 10, 2025 08:27
@lockshaw lockshaw changed the title Update README & other docs post-repo-split Update CONTRIBUTING.md post-repo-split Jan 10, 2025
Copy link
Collaborator

@victorli2002 victorli2002 left a comment

Choose a reason for hiding this comment

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

Reviewed 47 of 453 files at r1, all commit messages.
Reviewable status: 47 of 453 files reviewed, 1 unresolved discussion (waiting on @eric-zheng, @lockshaw, and @Marsella8)


CONTRIBUTING.md line 15 at r2 (raw file):

   2. If you don't have root permissions: [DavHau/nix-portable](https://github.com/DavHau/nix-portable). 
      Note that nix-portable does not work particularly well if the nix store is in NFS, so if you are running on an 

It might be helpful to say what NFS is (idk what it is).

Copy link
Contributor

@Marsella8 Marsella8 left a comment

Choose a reason for hiding this comment

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

Reviewable status: 47 of 453 files reviewed, 2 unresolved discussions (waiting on @eric-zheng and @lockshaw)


CONTRIBUTING.md line 59 at r2 (raw file):

(ff) $ proj cmake
...
(ff) $ proj test

also add a comment related to running tests without running the GPU tests? I think you mentioned something like that in the last meeting

Copy link

codecov bot commented Jan 20, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 60.47%. Comparing base (0bde2da) to head (b46b1ad).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1564   +/-   ##
=======================================
  Coverage   60.47%   60.47%           
=======================================
  Files         606      606           
  Lines       14723    14723           
=======================================
  Hits         8903     8903           
  Misses       5820     5820           
Flag Coverage Δ
unittests 60.47% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Copy link
Collaborator Author

@lockshaw lockshaw left a comment

Choose a reason for hiding this comment

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

Reviewable status: 46 of 453 files reviewed, 1 unresolved discussion (waiting on @eric-zheng, @Marsella8, and @victorli2002)


CONTRIBUTING.md line 15 at r2 (raw file):

Previously, victorli2002 (Victor Li) wrote…

It might be helpful to say what NFS is (idk what it is).

Done.


CONTRIBUTING.md line 59 at r2 (raw file):

Previously, Marsella8 wrote…

also add a comment related to running tests without running the GPU tests? I think you mentioned something like that in the last meeting

Done.

Copy link
Contributor

@Marsella8 Marsella8 left a comment

Choose a reason for hiding this comment

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

Reviewed all commit messages.
Reviewable status: 46 of 453 files reviewed, all discussions resolved (waiting on @eric-zheng and @victorli2002)

@lockshaw lockshaw merged commit 34f3848 into flexflow:master Jan 20, 2025
5 of 7 checks passed
@lockshaw lockshaw deleted the update-readme branch January 20, 2025 22:39
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.

3 participants