Create CONTRIBUTING.md
Browse files- CONTRIBUTING.md +51 -0
CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Contributing
|
| 2 |
+
|
| 3 |
+
## Developer Certificate of Origin
|
| 4 |
+
|
| 5 |
+
The Developer Certificate of Origin (DCO) is a way to certify that you wrote or otherwise have the right to submit the code you are contributing to the project.
|
| 6 |
+
|
| 7 |
+
By signing off on your contribution, you certify the following DCO (Version 1.1):
|
| 8 |
+
|
| 9 |
+
> **Developer Certificate of Origin**
|
| 10 |
+
> Version 1.1
|
| 11 |
+
>
|
| 12 |
+
> Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
|
| 13 |
+
>
|
| 14 |
+
> By making a contribution to this project, I certify that:
|
| 15 |
+
>
|
| 16 |
+
> (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
|
| 17 |
+
>
|
| 18 |
+
> (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
|
| 19 |
+
>
|
| 20 |
+
> (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
|
| 21 |
+
>
|
| 22 |
+
> (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.
|
| 23 |
+
|
| 24 |
+
## Sign your work
|
| 25 |
+
|
| 26 |
+
To certify the DCO, you must add a "Signed-off-by" line to your commit messages.
|
| 27 |
+
|
| 28 |
+
**Important:** You must use your real name (no pseudonyms or anonymous contributions).
|
| 29 |
+
|
| 30 |
+
**Example:**
|
| 31 |
+
|
| 32 |
+
```text
|
| 33 |
+
Fix typo in tokenizer config
|
| 34 |
+
|
| 35 |
+
Signed-off-by: Your Name <your@email.com>
|
| 36 |
+
```
|
| 37 |
+
|
| 38 |
+
### Git Command
|
| 39 |
+
|
| 40 |
+
If you are using the command line, you can sign off automatically by adding the `-s` flag:
|
| 41 |
+
|
| 42 |
+
```bash
|
| 43 |
+
git commit -s -m "Your commit message"
|
| 44 |
+
```
|
| 45 |
+
|
| 46 |
+
## Submitting changes
|
| 47 |
+
|
| 48 |
+
1. **Fork the repository** on Hugging Face.
|
| 49 |
+
2. **Create a branch** for your fix.
|
| 50 |
+
3. **Commit your changes** with the `-s` flag to sign them.
|
| 51 |
+
4. **Open a Pull Request** (PR) on the Community tab of the model page.
|