Skip to content

Commit

Permalink
Merge pull request #255 from rayrayraykk/contrib
Browse files Browse the repository at this point in the history
[Documentation] Update contribute guidance
  • Loading branch information
yxdyc authored Jul 22, 2022
2 parents bc6eb8b + ab9d850 commit 91ad46f
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,20 @@ More publications can be found in the [Publications](https://federatedscope.io/y

## Contributing

We **greatly appreciate** any contribution to FederatedScope! You can refer to [Contributing to FederatedScope](https://federatedscope.io/docs/contributor/) for more details.
We **greatly appreciate** any contribution to FederatedScope! We provide a developer version of FederatedScope with additional pre-commit hooks to perform commit checks compared to the official version:

```bash
# Install the developer version
pip install -e .[dev]
pre-commit install

# Or switch to the developer version from the official version
pip install pre-commit
pre-commit install
pre-commit run --all-files
```

You can refer to [Contributing to FederatedScope](https://federatedscope.io/docs/contributor/) for more details.

Welcome to join in our [Slack channel](https://join.slack.com/t/federatedscopeteam/shared_invite/zt-1apmfjqmc-hvpYbsWJdm7D93wPNXbqww), or DingDing group (please scan the following QR code) for discussion.

Expand Down

0 comments on commit 91ad46f

Please # to comment.