| # Contributing to the Open Reaction Database |
|
|
| Thanks for helping out! What would you like to do? |
|
|
| * [Report an issue](#report-an-issue) |
| * [Suggest an improvement (such as a new dataset)](#suggest-an-improvement) |
| * [Submit a new dataset](#submit-a-new-dataset) |
|
|
| ## Report an issue |
|
|
| Sorry to hear that you're having trouble! Please [file a bug report](https://github.com/Open-Reaction-Database/ord-data/issues/new?assignees=&labels=bug&template=bug_report.md&title=) to tell us about the problem. |
|
|
| ## Suggest an improvement |
|
|
| Great idea! Please [create a feature request](https://github.com/Open-Reaction-Database/ord-data/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=) to let us know what you'd like to see. |
|
|
| ## Submit a new dataset |
|
|
| Excellent! Please follow the |
| [Submission Workflow](https://ord-schema.readthedocs.io/en/latest/submissions.html) |
| in the documentation. |
|
|
| **Note on the target branch:** open your pull request against `main`. If it adds |
| or changes dataset files, a workflow moves it onto a `#<number>` branch in this |
| repository and comments to say so — your diff is unchanged and nothing is |
| required from you. That branch exists because the submission workflow pushes the |
| processed dataset back (assigning reaction and dataset IDs, moving files into |
| `data/`), which GitHub Actions cannot do on a fork. |
|
|
| **Note on large files (Git LFS):** Published datasets under `data/` are stored |
| with [Git LFS](https://git-lfs.com/), and clones fetch the objects from the |
| [Hugging Face mirror](https://huggingface.co/datasets/open-reaction-database/ord-data) |
| to conserve GitHub bandwidth. A new submission staged at the repository root is |
| an ordinary file, so you can push it from a fork with no LFS setup; the |
| submission workflow moves it into `data/` for you. |
|
|
| Only if you push changes to a file that already lives under `data/` (i.e. an LFS |
| object) do you need to point LFS uploads at your own fork first, since you cannot |
| write to the canonical repository's LFS store: |
|
|
| ``` |
| git config lfs.pushurl https://github.com/<your-username>/ord-data.git/info/lfs |
| ``` |
|
|
| ## Terms of Use |
|
|
| By submitting Contributions (as defined below) to this project, you agree that |
| You (as defined below) and your Contributions are bound to the following terms. |
|
|
| <p align="center">Open Reaction Database Project License Agreement</p> |
|
|
| In order to clarify the intellectual property license granted with Contributions |
| to the Open Access Reaction Database from any person or entity, the You must |
| indicate agreement to the license terms below. |
|
|
| You accept and agree to the following terms and conditions for Your present and |
| future Contributions submitted to ORDP. Except for the license granted herein to |
| ORDP and recipients of data distributed by ORDP, You reserve all right, title, |
| and interest in and to Your Contributions. |
|
|
| 1. Definitions. "You" (or "Your") shall mean the copyright owner or legal entity |
| authorized by the copyright owner that is making this Agreement with ORDP. For |
| legal entities, the entity making a Contribution and all other entities that |
| control, are controlled by, or are under common control with that entity are |
| considered to be a single Contributor. For the purposes of this definition, |
| "control" means (i) the power, direct or indirect, to cause the direction or |
| management of such entity, whether by contract or otherwise, or (ii) ownership |
| of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial |
| ownership of such entity. "Contribution" shall mean the data, code, |
| documentation or any original work of authorship, including any modifications or |
| additions to an existing work, that is intentionally submitted by You to ORDP |
| for inclusion in the Open Reaction Database managed by ORDP (the "Work"). For |
| the purposes of this definition, "submitted" means any form of electronic or |
| written communication sent to ORDP or its representatives, including but not |
| limited to communication on electronic mailing lists, but excluding |
| communication that is conspicuously marked or otherwise designated in writing by |
| You as "Not a Contribution." |
|
|
| 2. Grant of Copyright License. Subject to the terms and conditions of this |
| Agreement, You hereby grant to ORDP and to recipients of the data, software, or |
| documentation distributed by ORDP a perpetual, worldwide, non-exclusive, |
| no-charge, royalty-free, irrevocable copyright license to reproduce, prepare |
| derivative works of, publicly display, publicly perform, sublicense, and |
| distribute Your Contributions and such derivative works. |
|
|
| 3. Grant of Patent License. Subject to the terms and conditions of this |
| Agreement, You hereby grant to ORDP and to recipients of software distributed by |
| ORDP a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable |
| (except as stated in this section) patent license to make, have made, use, offer |
| to sell, sell, import, and otherwise transfer the Work, where such license |
| applies only to those patent claims licensable by You that are necessarily |
| infringed by Your Contribution(s) alone or by combination of Your |
| Contribution(s) with the Work to which such Contribution(s) was submitted. If |
| any entity institutes patent litigation against You or any other entity |
| (including a cross-claim or counterclaim in a lawsuit) alleging that your |
| Contribution, or the Work to which you have contributed, constitutes direct or |
| contributory patent infringement, then any patent licenses granted to that |
| entity under this Agreement for that Contribution or Work shall terminate as of |
| the date such litigation is filed. |
|
|
| 4. You represent that you are legally entitled to grant the above license. If |
| your employer(s) has rights to intellectual property that you create that |
| includes your Contributions, you represent that you have received permission to |
| make Contributions on behalf of that employer, or that your employer has waived |
| such rights for your Contributions to ORDP. |
|
|
| 5. You are not expected to provide support for Your Contributions, except to the |
| extent You desire to provide support. You may provide support for free, for a |
| fee, or not at all. Unless required by applicable law or agreed to in writing, |
| You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR |
| CONDITIONS OF ANY KIND, either express or implied, including, without |
| limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, |
| MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. |
|
|
