From 176371d334e03b4f0fb09e576b72d35bdcd99fba Mon Sep 17 00:00:00 2001 From: Usman Aziz Date: Tue, 10 Dec 2024 21:08:05 +0500 Subject: [PATCH] Improve community artifacts. (#91) --- CODE_OF_CONDUCT.md | 3 +++ CONTRIBUTING.md | 22 ++++++++++++++++++++++ README => README.md | 10 ++++++---- 3 files changed, 31 insertions(+), 4 deletions(-) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md rename README => README.md (67%) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..7e8ff46d --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,3 @@ +# Code of Conduct + +The tt-torch project follows the Code of Conduct for tt-mlir project that can be found at: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..416452aa --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,22 @@ +# Contributing guidelines for TT-Torch + +## PR Guidelines +### Community contributions +Thank you for your interest in the TT-Torch project we appreciate your support. +For all PRs we have an internal policy listed below which your PR will go through after an initial review has been done. + +The initial review will encompase the following: +* Review the PR for CI / CD Readiness. Includes making sure that the code and PR at a high level makes sense for the project +* Once approved for CI / CD readiness a Tenstorrent developer will kick off our CI/CD pipeline on your behalf. + +### Internal contributions +For internal contributions we have the following guidelines: + +* A 24 hour merge rule exists. The rule is to wait at least 24 hours since the PR was initially opened for review. This gives members of our teams that span the globe opportunity to provide feedback to PRs. + +In addition to the 24 hour rule the following prerequisites for landing PR exist: +* At least 1 reviewer signs off on the change +* Component owner sign offs (github will tell you if this hasn't been met) +* Green CI +* Wait at least 24 hours since opening the PR to give all tagged reviewers a chance to take a look. Or at least comment on the issue that they need more time to review. + * *Rebasing or further changes to the PR do not reset the 24 hour counter.* diff --git a/README b/README.md similarity index 67% rename from README rename to README.md index 79d34f03..e3c14394 100644 --- a/README +++ b/README.md @@ -1,7 +1,9 @@ -Make sure to install -`sudo apt-get install python3.11-dev python3.11-venv` +# tt-torch -Steps: +The tt-torch project requires environment setup from tt-mlir project. https://github.com/tenstorrent/tt-mlir/ +See documentation of tt-mlir and follow Environment setup. https://docs.tenstorrent.com/tt-mlir/build.html + +## Steps: ``` source env/activate cmake -G Ninja -B build @@ -9,7 +11,7 @@ cmake --build build cmake --install build ``` -### Pre-Commit +## Pre-Commit Pre-Commit applies a git hook to the local repository such that linting is checked and applied on every `git commit` action. Install from the root of the repository using: ```bash