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 #1142

Merged
merged 3 commits into from
May 12, 2024
Merged

Conversation

zaicruvoir1rominet
Copy link
Contributor

Summary

Update CONTRIBUTING.md to make the PR process smoother for newcomers.
Issue: #1084

Test Plan

None

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label May 10, 2024
@zaicruvoir1rominet
Copy link
Contributor Author

zaicruvoir1rominet commented May 10, 2024

The process is not complete yet:

  • Following these steps doesn't seem to place the built libcst.native at the correct spot, resulting in libcst.native import errors when using hatch run test.
  • Pyre seems to have a configuration problem when using hatch run lint, resulting in traces far different from the main libcst GitHub CI

Any thoughts on how to solve this ?
(For my PR, I just ditched hatch altogether, using the pytproject.toml as base ; getting the libcst.native from a compiled version)

@zsol
Copy link
Member

zsol commented May 12, 2024

Thank you, this is great!

@zsol zsol merged commit e7b0096 into Instagram:main May 12, 2024
21 checks passed
@zsol
Copy link
Member

zsol commented May 12, 2024

Oh whoops I missed your questions. Let me see if I can figure it out tomorrow

@zsol
Copy link
Member

zsol commented May 13, 2024

I can't repro either of the problems you mention if I follow the instructions. FWIW I'm running hatch v1.10.0 on MacOS and I can see

  Copying rust artifact from native/target/debug/liblibcst_native.dylib to libcst/native.cpython-310-darwin.so

in the output of hatch -vvv env create.

As for the typechecking issue, hatch run lint doesn't run the type checker, hatch run typecheck does. Maybe worth adding that to the doc

@zaicruvoir1rominet zaicruvoir1rominet deleted the update_contributing_doc branch May 13, 2024 11:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants