KennethEnevoldsen commited on
Commit
bb8789e
·
unverified ·
1 Parent(s): 038a8e7

docs: Added contribution guidelines

Browse files
Files changed (2) hide show
  1. CONTRIBUTING.md +35 -1
  2. README.md +5 -0
CONTRIBUTING.md CHANGED
@@ -17,4 +17,38 @@ dataset = load_dataset("../.", split="train")
17
  # make transformations here
18
  ```
19
 
20
- > Note: While it is local Huggingface still uses a cache, therefore you might need to reset it after changes have been made to see that it works correctly. You can do this by deleting the cached files which you can locate using `dataset.cache_files`.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
17
  # make transformations here
18
  ```
19
 
20
+ > Note: While it is local Huggingface still uses a cache, therefore you might need to reset it after changes have been made to see that it works correctly. You can do this by deleting the cached files which you can locate using `dataset.cache_files`.
21
+
22
+ ## Installing dependencies
23
+
24
+ This repo comes with a few dependencies you need to install to make this run. It uses a [makefile](https://opensource.com/article/18/8/what-how-makefile) to run commands and a [uv](https://docs.astral.sh/uv/) for package management. Once you have uv installed you can install the dependencies using:
25
+
26
+ ```bash
27
+ make install
28
+ ```
29
+
30
+ ## Running dataset tests
31
+
32
+ This dataset is special as it comes with a test suite, e.g. testing in the ids are unique and that the format is consistent. You can run the suite using
33
+
34
+ ```bash
35
+ make test
36
+ ```
37
+
38
+ ## Submitting a PR
39
+
40
+ Creating a PR on Huggingface is a bit different from creating one on Github.
41
+
42
+ 1) Go to the community tab on huggingface press *new pull request* and choose *on your machine*. Specify the title of the your PR. Then you can simply:
43
+
44
+ ```bash
45
+ git checkout pr/{PR NUMBER}
46
+ # make your changes here
47
+ # push to hub
48
+ git push origin pr/11:refs/pr/11
49
+ ```
50
+
51
+ Before you make the PR do be sure to make sure that the tests have been run.
52
+
53
+ To see example PR you can see the following:
54
+ - [Restructuring columns in the dataset](https://huggingface.co/datasets/danish-foundation-models/danish-gigaword-2/discussions/11)
README.md CHANGED
@@ -125,6 +125,7 @@ language_bcp47:
125
  - [Dataset Creation](#dataset-creation)
126
  - [Source Data](#source-data)
127
  - [Additional Information](#additional-information)
 
128
  - [Citation Information](#citation-information)
129
 
130
  ## Dataset Description
@@ -280,8 +281,12 @@ longname_mapping_dict = {
280
  }
281
  ```
282
 
 
283
  ## Additional Information
284
 
 
 
 
285
 
286
  ### Citation Information
287
 
 
125
  - [Dataset Creation](#dataset-creation)
126
  - [Source Data](#source-data)
127
  - [Additional Information](#additional-information)
128
+ - [Contributing the dataset](#contributing-the-dataset)
129
  - [Citation Information](#citation-information)
130
 
131
  ## Dataset Description
 
281
  }
282
  ```
283
 
284
+
285
  ## Additional Information
286
 
287
+ ### Contributing the dataset
288
+
289
+ We welcome contributions to the dataset such as new sources, better data filtering and so on. To get started on contributing please see [the contribution guidelines](CONTRIBUTING.md)
290
 
291
  ### Citation Information
292