Skip to content

Latest commit

 

History

History
44 lines (34 loc) · 3.53 KB

CONTRIBUTING_en.md

File metadata and controls

44 lines (34 loc) · 3.53 KB
Raw

Contribution Guidelines

한국어 | English

👋 We warmly welcome contributions! To contribute, please follow the guidelines below.

Contribution Policy

  • Project Restrictions: Only open-source projects can be registered. The entire project must be openly available as open-source. If only a portion is publicly available, a significant part must be open-source. The project owner will determine what constitutes a 'significant part.' If there are any disputes, a Discussion can be initiated to resolve them.
  • License Setting Recommendation: It is recommended to set a license for the open-source projects you register. Without a license, it may be difficult to understand the clear usage scope, leading to confusion. However, this is a recommendation, and projects without licenses can still be registered.

Types of Contributions

  • Adding Projects: If you wish to add a project, please do so via an Issue or Pull Request.
  • Translation Contributions: The awesome-chzzk project aims to be multi-lingual (with Korean as the base language). Please contribute translation PRs to help developers worldwide engage with the Chzzk third-party ecosystem.

How to Contribute

Adding a Project (Using Issues)

  1. Create an Issue: Go to the 'Issues' tab in the GitHub repository and click on 'New issue' to create a new issue.
  2. Fill Out Issue Template: Clearly write down the project's name, description, etc., following the provided template.
  3. Submit the Issue: After completion, click on 'Submit new issue' to submit.
  4. Wait for Feedback: The community or project administrators will review the issue and provide feedback.

Adding a Project (Using Pull Requests)

  1. Fork the Repository: Fork the awesome-chzzk repository to your account on GitHub.
  2. Add Changes: In your forked repository, add the new project. Please ensure to appropriately add the project in the README.md file.
  3. (Optional) Add Translation: In addition to the README.md file, you may also add a translated version in files like README_en.md. This is optional; if only one language is submitted, the project administrators will add the translated content.
  4. Create a Pull Request: Commit your changes and create a Pull Request to the original repository.
  5. Fill Out PR Template: Fill in the necessary information as per the provided PR template.
  6. Submit PR and Wait for Feedback: After submitting the PR, wait for the project administrator's review and feedback.

Contributing Translations (Using Pull Requests)

  1. Select Content to Translate: Choose the content you wish to translate. Ensure it is not already being translated or completed.
  2. Fork Repository and Start Translating: Fork the awesome-chzzk repository and start the translation.
  3. Commit Translated Content: After completing the translation, commit the content.
  4. Create a Pull Request: Create a Pull Request with your translations to the original repository.
  5. Submit PR and Wait for Feedback: Submit the PR and wait for the project administrator's review and feedback.

Contribution Checklist

TBD (To be written)

If you have any inquiries or suggestions regarding the project, feel free to share them in the Issues section. Your valuable contributions greatly assist in the development of the project. Thank you! 🌟