Alaamer commited on
Commit
dd3c460
·
verified ·
1 Parent(s): 5401db8

Upload CONTRIBUTING.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. CONTRIBUTING.md +44 -0
CONTRIBUTING.md ADDED
@@ -0,0 +1,44 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Contributing to Medium Articles Dataset
2
+
3
+ We love your input! We want to make contributing to this dataset as easy and transparent as possible, whether it's:
4
+
5
+ - Reporting a bug
6
+ - Discussing the current state of the data
7
+ - Submitting a fix
8
+ - Proposing new features
9
+ - Becoming a maintainer
10
+
11
+ ## Development Process
12
+
13
+ We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
14
+
15
+ 1. Fork the repo and create your branch from `main`.
16
+ 2. If you've added code that should be tested, add tests.
17
+ 3. If you've changed APIs, update the documentation.
18
+ 4. Ensure the test suite passes.
19
+ 5. Make sure your code follows the existing style.
20
+ 6. Issue that pull request!
21
+
22
+ ## Any Contributions You Make Will Be Under the MIT License
23
+
24
+ When you submit code changes, your submissions are understood to be under the same [MIT License](LICENSE) that covers the project.
25
+
26
+ ## Report Bugs Using GitHub's [Issue Tracker]
27
+
28
+ We use GitHub issues to track public bugs. Report a bug by [opening a new issue]().
29
+
30
+ ## Write Bug Reports With Detail, Background, and Sample Code
31
+
32
+ **Great Bug Reports** tend to have:
33
+
34
+ - A quick summary and/or background
35
+ - Steps to reproduce
36
+ - Be specific!
37
+ - Give sample code if you can.
38
+ - What you expected would happen
39
+ - What actually happens
40
+ - Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
41
+
42
+ ## License
43
+
44
+ By contributing, you agree that your contributions will be licensed under its MIT License.