Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (50 loc) · 3.95 KB

CONTRIBUTING.md

File metadata and controls

69 lines (50 loc) · 3.95 KB
Raw

Contribution Guidelines

𝐓𝐡𝐚𝐧𝐤 𝐲𝐨𝐮 𝐟𝐨𝐫 𝐲𝐨𝐮𝐫 𝐜𝐨𝐧𝐭𝐫𝐢𝐛𝐮𝐭𝐢𝐨𝐧 𝐭𝐨 𝐭𝐡𝐞 𝐩𝐫𝐨𝐣𝐞𝐜𝐭!
𝐖𝐞 𝐰𝐚𝐫𝐦𝐥𝐲 𝐰𝐞𝐥𝐜𝐨𝐦𝐞 𝐲𝐨𝐮 𝐭𝐨 𝐚𝐬𝐤 𝐪𝐮𝐞𝐬𝐭𝐢𝐨𝐧𝐬, 𝐫𝐞𝐩𝐨𝐫𝐭 𝐞𝐫𝐫𝐨𝐫𝐬 𝐨𝐫 𝐬𝐮𝐛𝐦𝐢𝐭 𝐜𝐨𝐝𝐞.
𝐏𝐥𝐞𝐚𝐬𝐞 𝐟𝐨𝐥𝐥𝐨𝐰 𝐭𝐡𝐞 𝐟𝐨𝐥𝐥𝐨𝐰𝐢𝐧𝐠 𝐬𝐭𝐞𝐩𝐬 𝐭𝐨 𝐨𝐩𝐞𝐫𝐚𝐭𝐞.

💬 Issues

  1. If you find a bug or have a feature request, submit a detailed description following provided issue template in the issue page.

  2. 𝐓𝐡𝐞 𝐨𝐯𝐞𝐫𝐚𝐥𝐥 𝐩𝐫𝐨𝐜𝐞𝐬𝐬 𝐢𝐧𝐜𝐥𝐮𝐝𝐞𝐬:

    • Check if same issue exists.
    • Describe what you encountered and expected.
    • Steps to reproduce the problem.
    • The environment where the problem occurs (operating system, package version, etc.)
    • Other information, such as screenshots, logs, etc.

Important

Please ensure to provide sufficient information,
so that we can reproduce the problem or understand the functional requirements.

📤 Pull Request

  1. 𝐌𝐚𝐢𝐧 𝐬𝐭𝐞𝐩𝐬

    • Fork the repository to your own GitHub account.
    • Clone the forked repository to your local machine.
    • Create a new branch for your contribution. Such as feature/your-feature-name or bugfix/your-bugfix-name.
    • Make your changes and commit them to your new branch.
    • Push your changes to your forked repository.
    • Create a Pull Request(PR) from your forked repository to the original repository.
    • Wait for the PR to be reviewed and merged.

  2. 𝐏𝐨𝐢𝐧𝐭𝐬 𝐭𝐨 𝐧𝐨𝐭𝐞

    • Branching management: Before making code contributions, create a new branch from the master branch and give it a descriptive name. For example, feature/your-feature-name or bugfix/your-bugfix-name.

    • Code style:

      • Follow the PEP 8 code specification.。
      • Ensure that the code has good readability and maintainability.
      • Add comments for complex logic and non-obvious code.

    • Code test:

      • Please add appropriate tests to your code.
      • Ensure that the test covers your new function or fixed bug.
      • Before submitting code, run all tests and ensure they pass.

    • Submit a Pull Request(PR):

      Please clearly explain the following content according to the provided PR template

      • Your contribution content, including the problems solved or functions added.
      • If you have fixed the issue, please reference it.
      • Test methods, steps and results
      • Other information, such as screenshots, logs, etc.

🧐 Code review

  • All PRs will go through code review. Other developers may offer suggestions and feedback to improve the quality of the code.
  • Please actively participate in the code review process, reply to the reviewer's questions and suggestions, and make modifications as needed.

📜 Code of conduct

  • Please abide by GitHub's code of conduct and the terms of this project's open source license.
  • Maintain respect and courtesy in communication. Avoid offensive language and personal attacks.
  • Different viewpoints and opinions are welcome, but please discuss in a constructive way.

🤝 Acknowledgement

𝓦𝓮 𝓪𝓻𝓮 𝓮𝔁𝓽𝓻𝓮𝓶𝓮𝓵𝔂 𝓰𝓻𝓪𝓽𝓮𝓯𝓾𝓵 𝓽𝓸 𝓪𝓵𝓵 𝓬𝓸𝓷𝓽𝓻𝓲𝓫𝓾𝓽𝓸𝓻𝓼 !

Your efforts and contributions have made this project better. If your contribution is accepted, you will be included in the list of contributors to the project.