README.md 1.51 KB
Newer Older
1
2
# Contributing

yuxionghe's avatar
yuxionghe committed
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
DeepSpeed welcomes your contributions!

## Prerequisites

We use [pre-commit](https://pre-commit.com/) to ensure that formatting is consistent across DeepSpeed.
First, ensure that `pre-commit` is installed from either installing DeepSpeed or `pip install pre-commit`.
Next, the pre-commit hooks must be installed once before commits can be made:
```
pre-commit install
```
Afterwards, our suite of formatting tests run automatically before each `git commit`. You can also
run these manually:
```
pre-commit run --all-files
```


## Contributor License Agreement

22
23
24
25
26
27
28
29
This project welcomes contributions and suggestions.  Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
provided by the bot. You will only need to do this once across all repos using our CLA.

yuxionghe's avatar
yuxionghe committed
30
31
## Code of Conduct

32
33
34
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.