Skip to content

[Feature] Change contribution guide #2662

@zhaochenyang20

Description

@zhaochenyang20

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

Metadata

Metadata

Labels

documentationImprovements or additions to documentationgood first issueGood for newcomers

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions