-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7348032
commit 6029539
Showing
1 changed file
with
31 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,31 @@ | ||
WIP | ||
# Contribution Guidelines | ||
|
||
If you want to contribute, please follow these simple rules to help keep everything clear and useful: | ||
|
||
### Licensing and Credit | ||
|
||
1. **License**: All content is under the [CC BY-NC 4.0 license](https://creativecommons.org/licenses/by-nc/4.0/). You can share, copy, and modify the content as long as you give proper credit and don’t use it for commercial purposes. | ||
|
||
2. **Credit**: You can credit yourself for sections you write by using markdown footnotes. For example: | ||
`[^C1]: This section was written by [Author Name]((Webpage/Email/Or Donation Address))` | ||
|
||
### Content Creation | ||
|
||
1. **No AI-Generated Content**: Please write the content yourself. AI can only be used for fixing grammar and spelling errors, not for creating or generating information. If moderators suspect content is AI-generated, it may not be approved. | ||
|
||
2. **Link Additional Resources**: If there are other helpful resources related to your content, link to them using markdown footnotes. For example: | ||
`[^R1]: Find more details: [link](link).` | ||
|
||
3. **Screenshots**: If you need to add screenshots, make sure they are clear and of good quality. Reduce the size or use formats like JPG to keep them manageable. | ||
|
||
### Formatting and Consistency | ||
|
||
1. **Follow the Guide Format**: Match the structure of the existing guide. Each section should have a similar format and provide clear explanations, just like the rest of the guide. | ||
|
||
2. **Content Structure**: Each document should include: | ||
- **How It Works**: Explain the protocol, tool, or technique. | ||
- **Privacy and Security Measures**: Cover any important privacy and security considerations. | ||
- **Implementations**: Describe existing implementations. | ||
- **Setup and Use**: Provide instructions on how to set up and use it. | ||
|
||
By following these guidelines, you help maintain the quality and consistency of the guide, making it easier for everyone to use and understand. Thank you for your contributions comrade \*salutes\*! |