Datasets:
Delete CONTRIBUTING.md
Browse files- CONTRIBUTING.md +0 -59
CONTRIBUTING.md
DELETED
|
@@ -1,59 +0,0 @@
|
|
| 1 |
-
# Contributing to OPheno
|
| 2 |
-
|
| 3 |
-
Thank you for your interest in contributing to the OPheno: Open-Source Weed Phenology Database! Your contributions are valuable in making this dataset a more comprehensive resource for the agricultural science community.
|
| 4 |
-
|
| 5 |
-
## How to Contribute
|
| 6 |
-
|
| 7 |
-
We welcome contributions of weed emergence and phenology data. To ensure data quality and consistency, we recommend the following process:
|
| 8 |
-
|
| 9 |
-
1. **Discuss First (Optional but Recommended):** Open an [Issue](https://huggingface.co/datasets/hkromminga/opheno/discussions/new) on the Hugging Face Hub repository briefly describing the data you'd like to contribute (e.g., type of data, species, location, time frame). This helps coordinate efforts and ensure the data fits the project scope.
|
| 10 |
-
2. **Prepare Your Data:** Format your data according to the guidelines below.
|
| 11 |
-
3. **Submit Your Data:** [Choose **one** preferred method and describe it clearly. Delete the others]
|
| 12 |
-
* Create a branch from main of the repository
|
| 13 |
-
* Add your data file (preferably CSV or Parquet) to your new branch (e.g., in a temporary `contributions/` directory).
|
| 14 |
-
* Create a Pull Request (PR) from your branch to the main OPheno repository. In the PR description, include details about the data source (full citation!), context, and confirm you agree to the licensing terms.
|
| 15 |
-
|
| 16 |
-
## Data Format
|
| 17 |
-
|
| 18 |
-
Please provide your data in **CSV** or **Parquet** format, using UTF-8 encoding. The file should include the following columns, matching the definitions in the main dataset `README.md`:
|
| 19 |
-
|
| 20 |
-
**Required Columns:**
|
| 21 |
-
* `observation_date` (YYYY-MM-DD)
|
| 22 |
-
* `latitude` (Decimal degrees, WGS84)
|
| 23 |
-
* `longitude` (Decimal degrees, WGS84)
|
| 24 |
-
* `scientific_name` (Assessed plant)
|
| 25 |
-
* `eppo_code` (https://gd.eppo.int/search)
|
| 26 |
-
* `assessment_type` (See allowed values in main `README.md`)
|
| 27 |
-
* `assessment_value` (Value corresponding to `assessment_type`)
|
| 28 |
-
* `assessment_unit` (Unit corresponding to `assessment_value`, see `README.md`)
|
| 29 |
-
* **`source_citation`** (A unique key you provide, e.g., AuthorYear DOI, linked to the **full citation** of the data source - **This is crucial!**)
|
| 30 |
-
|
| 31 |
-
**Highly Recommended Columns:**
|
| 32 |
-
* `year` (YYYY)
|
| 33 |
-
* `location_name` (Description of site)
|
| 34 |
-
* `crop_present` (If applicable)
|
| 35 |
-
* `experimental_details` (Relevant context like tillage, treatments)
|
| 36 |
-
|
| 37 |
-
**Optional Columns:**
|
| 38 |
-
* `observation_id` (If you have a unique row ID; otherwise, maintainers will generate one)
|
| 39 |
-
* `timeseries_id` (Use this **optional** field to provide a consistent identifier for all observations belonging to a single, distinct time series measurement sequence, e.g., observations from the same specific plot over multiple dates. Leave blank if not applicable or unknown.)
|
| 40 |
-
|
| 41 |
-
## Data Content Guidelines
|
| 42 |
-
|
| 43 |
-
* Please ensure data accuracy to the best of your knowledge.
|
| 44 |
-
* Refer to the main `README.md` for the list of defined `assessment_type` codes and the expected format/range for `assessment_value` and `assessment_unit` for each type.
|
| 45 |
-
* Provide the **full citation** information corresponding to your `source_citation_key` along with your data submission (e.g., in the PR description, Issue comment, or email).
|
| 46 |
-
|
| 47 |
-
## Review Process
|
| 48 |
-
|
| 49 |
-
Maintainers will review submitted data for compatibility, completeness (especially citation info), and basic quality checks. We may contact you if clarification is needed. Validated data will then be merged into the main OPheno dataset during periodic updates.
|
| 50 |
-
|
| 51 |
-
## Licensing
|
| 52 |
-
|
| 53 |
-
By contributing data, you agree to license it under the **Creative Commons Attribution 4.0 International (CC BY 4.0)** license, consistent with the rest of the OPheno dataset. This allows others to share and adapt the data freely with appropriate attribution.
|
| 54 |
-
|
| 55 |
-
## Questions?
|
| 56 |
-
|
| 57 |
-
If you have questions about contributing, please open an Issue or contact the maintainers ([Provide Contact Info if different from Issues]).
|
| 58 |
-
|
| 59 |
-
Thank you for helping build OPheno!
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|