Skip to content

Commit 76b0b26

Browse files
committed
contributing section
1 parent af8ac8c commit 76b0b26

File tree

4 files changed

+17
-1
lines changed

4 files changed

+17
-1
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,20 @@ sampled_atom_pos = alphafold3(
9393
sampled_atom_pos.shape # (2, 16 * 27, 3)
9494
```
9595

96+
## Contributing
97+
98+
At the project root, run
99+
100+
```bash
101+
$ sh ./contribute.sh
102+
```
103+
104+
Then, add your module to `alphafold3_pytorch/alphafold3.py`, add your tests to `tests/test_af3.py`, and submit a pull request. You can run the tests locally with
105+
106+
```bash
107+
$ pytest tests/
108+
```
109+
96110
## Citations
97111

98112
```bibtex

alphafold3_pytorch/alphafold3.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@
3131
Module,
3232
ModuleList,
3333
Linear,
34-
Dropout,
3534
Sequential,
3635
)
3736

contribute.sh

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
cp .env.sample .env
2+
pip install -e '.[test]'
3+
pytest tests/
File renamed without changes.

0 commit comments

Comments
 (0)