Mirror 0f2e0ef from github.com/open-reaction-database/ord-data
Browse files- CONTRIBUTING.md +7 -0
CONTRIBUTING.md
CHANGED
|
@@ -20,6 +20,13 @@ Excellent! Please follow the
|
|
| 20 |
[Submission Workflow](https://ord-schema.readthedocs.io/en/latest/submissions.html)
|
| 21 |
in the documentation.
|
| 22 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 23 |
**Note on large files (Git LFS):** Published datasets under `data/` are stored
|
| 24 |
with [Git LFS](https://git-lfs.com/), and clones fetch the objects from the
|
| 25 |
[Hugging Face mirror](https://huggingface.co/datasets/open-reaction-database/ord-data)
|
|
|
|
| 20 |
[Submission Workflow](https://ord-schema.readthedocs.io/en/latest/submissions.html)
|
| 21 |
in the documentation.
|
| 22 |
|
| 23 |
+
**Note on the target branch:** open your pull request against `main`. If it adds
|
| 24 |
+
or changes dataset files, a workflow moves it onto a `#<number>` branch in this
|
| 25 |
+
repository and comments to say so — your diff is unchanged and nothing is
|
| 26 |
+
required from you. That branch exists because the submission workflow pushes the
|
| 27 |
+
processed dataset back (assigning reaction and dataset IDs, moving files into
|
| 28 |
+
`data/`), which GitHub Actions cannot do on a fork.
|
| 29 |
+
|
| 30 |
**Note on large files (Git LFS):** Published datasets under `data/` are stored
|
| 31 |
with [Git LFS](https://git-lfs.com/), and clones fetch the objects from the
|
| 32 |
[Hugging Face mirror](https://huggingface.co/datasets/open-reaction-database/ord-data)
|