Skip to content

Latest commit

 

History

History
46 lines (25 loc) · 2.73 KB

contributing.md

File metadata and controls

46 lines (25 loc) · 2.73 KB
Raw

Contribution Guidelines

Thank you for your interest in contributing to the awesome-debrid repository! We aim to maintain a comprehensive, accurate, and up-to-date list of debrid services and related resources. To ensure quality and consistency, we ask all contributors to follow these guidelines.

General Guidelines

  1. Alphabetized Lists: All lists, including debrid services, file systems, content managers, and communities, should be alphabetically ordered. This helps in maintaining consistency and ease of navigation.

  2. Adding a New Item: When adding a new service or resource, make sure it falls under the correct category. If you are unsure about the category, feel free to ask in your pull request.

  3. Descriptive Links: Use descriptive link texts that clearly indicate what the link is about. Avoid generic terms like "Click here" or "More info".

  4. Format and Structure: Follow the existing format and structure of the document. This includes using markdown syntax properly for headings, lists, and links.

Content-Specific Guidelines

Debrid Services

  • Verified Services: Only add debrid services that you have personally tested or that have substantial positive feedback from trusted sources.
  • Service Details: Provide essential details such as subscription plans, specific features (e.g., torrent support, one-click hosters), and any limitations.
  • Update Existing Services: If you find outdated information, feel free to update it with the latest details.

*Arr Stack, File System, and Content Managers

  • Briefly describe the purpose and key features of the software or tool.
  • Ensure the links are up-to-date and lead directly to the official or most relevant page.

Miscellaneous and Communities

  • Include resources or communities that are actively maintained and relevant to debrid services.

Procedure for Contributing

  1. Fork the Repository: Start by forking the awesome-debrid repository.

  2. Make Your Changes: Add or update content in your forked repository. Ensure you follow the guidelines above.

  3. Pull Request: Submit a pull request to the main repository. In your pull request, provide a brief explanation of the changes and why they are beneficial.

  4. Review Process: Wait for the maintainers to review your pull request. Be open to feedback and be prepared to make revisions if requested.

By following these guidelines, you help maintain the quality and usefulness of the awesome-debrid repository. We appreciate your contributions and look forward to seeing your valuable additions!

License Reminder

Remember, all contributions are subject to the repository's license: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication.