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

[Feature] Change contribution guide #2662

Open
2 tasks done
zhaochenyang20 opened this issue Dec 30, 2024 · 2 comments
Open
2 tasks done

[Feature] Change contribution guide #2662

zhaochenyang20 opened this issue Dec 30, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@zhaochenyang20
Copy link
Collaborator

zhaochenyang20 commented Dec 30, 2024

Checklist

Motivation

https://sgl-project.github.io/references/contributor_guide.html

This has been outdated for long. We need to add guide on:

  1. How to run docs CI, build it locally, compile it and clean the output and make PR.
  2. How to do unit tests locally and add unit tests to CI.
  3. How to write elegant unit test following other tests.
  4. How to pre-commit.

Related resources

No response

@zhaochenyang20 zhaochenyang20 added documentation Improvements or additions to documentation good first issue Good for newcomers labels Dec 30, 2024
@zhaochenyang20 zhaochenyang20 self-assigned this Dec 30, 2024
@zhaochenyang20
Copy link
Collaborator Author

@shuaills This is a great issue to you 😂

@zhaochenyang20
Copy link
Collaborator Author

@shuaills Set up environments for beginner who even never use GPU.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant