Skip to content

Commit

Permalink
Improve community artifacts. (#91)
Browse files Browse the repository at this point in the history
  • Loading branch information
uazizTT authored Dec 10, 2024
1 parent 8bbd311 commit 176371d
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 4 deletions.
3 changes: 3 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -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: <https://tenstorrent.github.io/tt-mlir/code-of-conduct.html>
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.*
10 changes: 6 additions & 4 deletions README → README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
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
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
Expand Down

0 comments on commit 176371d

Please sign in to comment.