Skip to content

Latest commit

 

History

History
69 lines (44 loc) · 3.29 KB

CONTRIBUTING.md

File metadata and controls

69 lines (44 loc) · 3.29 KB
Raw

Contributing to kindling

Thank you for you interest in contributing to kindling! We welcome all people who want to contribute in a healthy and constructive manner within our community. ​

Become a contributor

you can contribute to Kindling in serveral ways,like: l Contribute to the codebase l Report and traige bugs l Write technical documentation and blog posts, for users and contributors l Help others by answering questions about Kindling For more ways to contribute, check out the Open Source Guides ​

Report bugs

Before submitting a new issue, try to make sure someone hasn’t already reported the problem. You can look through the existing issues for similar issues. ​

Report a bug by submitting a new issue. Make sure follow the issue template and add more detail informations that will help us replicate the problem.

Triage issues

If you don't have the knowledge or time to code, consider helping with issue triage. The community will thank you for saving them time by spending some of yours. Read more about the ways you can Triage issues.

Answering questions

It's important to us to help these users who has problem about kindlings, and we’d love you help. Go to disscussions, you can find unanswered questions and you can answer thoes questions.

You first contribution

The first step to getting starting contribute to kindling is to find something to work on. You can start by fixing biginner-fridendly issues or improving kindling documents ,no contribution is too small!

  • How to find biginner-friendly issues？Kindling has good first issue label for issues that don’t need high-level knowledge to contribute to. You can browser issues labeled good first time.

  • How to find documents improving issues? Kindling has doc improvement label for issues that you can improve kinding docs.

If you are ready to contribute code changes, review the developer guide for how to set up local environment. When you want to submit your local changes , read about create pull request.

Sign your commits

The sign-off is a simple line at the end of the explanation for a commit. All commits needs to be signed. Your signature certifies that you wrote the patch or otherwise have the right to contribute the material. The rules are pretty simple, if you can certify the rules (from developercertificate.org),then you just need add a line to every git commit message, like:

Signed-off-by: lina <lina@example.cn>

configuring automation commit signing in git

  1. set your user.name and user.email using following commands:

    git config --global user.name lina

git config --global user.email  lina@example.cn

  1. sign your commit with git commit -s, then usegit log to verify that the signed-off message is added.

    Author: lina <lina@example.cn>

Date:  Tue Jan 25 09:42:40 2022 +0800

  add content

  Signed-off-by: lina <lina@example.cn>