Skip to content

Commit 54d3e5d

Browse files
authored
Update to Contributions (google#87)
* updates to existing contributions page and linking it in the main README * remove trailining whitespaces * clarified guidelines in contributions
1 parent 893d7e3 commit 54d3e5d

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ Gradient.
2222
For more details about MLGO, please refer to our paper
2323
[MLGO: a Machine Learning Guided Compiler Optimizations Framework](https://arxiv.org/abs/2101.04808).
2424

25+
For more details about how to contribute to the project, please refer to
26+
[contributions](docs/contributing.md).
27+
2528
## Pretrained models
2629

2730
We occasionally release pretrained models that may be used as-is with LLVM.

docs/contributing.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
# How to Contribute
22

3-
We'd love to accept your patches and contributions to this project. There are
4-
just a few small guidelines you need to follow.
3+
We'd love to accept your patches and contributions to this project. A good
4+
starting step to get familiar with the project and set up a development
5+
enviroment as per [demo](docs/demo/demo.md). After running through the demo, a
6+
good second step is to pick up an open
7+
[issue](https://github.com/google/ml-compiler-opt/issues) or create one that you
8+
would like to work on and submit a patch for. Please make sure that your patch
9+
adheres to all the guidelines given below.
510

611
## Contributor License Agreement
712

0 commit comments

Comments
 (0)