Skip to content

Commit 2c2a970

Browse files
authored
Create CONTRIBUTING.md
1 parent 223a3ca commit 2c2a970

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
## Contributing
2+
3+
To implement a new functionality in the `aten` library, you must
4+
1. Add the class or function header in `aten/src/Tensor.h`
5+
2. Add the implementation in the correct file (or create a new one) in `aten./*Tensor/*.cpp`. Make sure to update `aten/bindings/CMakeLists.txt` if needed.
6+
3. Add its pybindings (if a public function that will be used in `ember`) in `aten/bindings/*bindings.cpp`. Make sure to update `aten/bindings/CMakeLists.txt` if needed.
7+
4. Add relevant C++ tests in `aten/test/`.
8+
5. Not necessary, but it's good to test it out on a personal script for a sanity check.
9+
6. Add to the stub files in `ember/aten/*.pyi`.
10+
7. Add Python tests in `test/`.
11+
8. If everything passes, you can submit a pull request.

0 commit comments

Comments
 (0)