Add some docs

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,8 @@
+## What is the purpose of the change?
+
+
+## Checklist
+- [x] Make sure there is a [GitHub_issue](https://github.com/jd-opensource/joylive-injector/issues) field for the change.
+- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
+- [x] Write necessary unit-test to verify your logic correction.
+- [x] Make sure gitHub actions can pass. [Why the workflow is failing and how to fix it?](../CONTRIBUTING.md)

CODE_OF_CONDUCT.md

@@ -0,0 +1,73 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance, race,
+religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at <https://joylivehq.slack.com>. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html)
+
+[homepage]: https://www.contributor-covenant.org

CONTRIBUTING.md

@@ -0,0 +1,78 @@
+# Contributing to JoyLive
+
+Welcome to JoyLive! This document is a guideline about how to contribute to JoyLive.
+If you find something incorrect or missing, please leave comments / suggestions.
+
+## Before you get started
+
+### Code of Conduct
+
+Please make sure to read and observe our [Code of Conduct](./CODE_OF_CONDUCT.md).
+
+### Setting up your development environment
+
+You should have JDK 17 or later installed in your system.
+
+## Contributing
+
+We are always very happy to have contributions, whether for typo fix, bug fix or big new features.
+Please do not ever hesitate to ask a question or send a pull request.
+
+We strongly value documentation and integration with other projects.
+We are very glad to accept improvements for these aspects.
+
+### GitHub workflow
+
+We use the `main` branch as the development branch, which indicates that this is a unstable branch.
+
+Here are the workflow for contributors:
+
+1. Fork to your own
+2. Clone fork to local repository
+3. Create a new branch and work on it
+4. Keep your branch in sync
+5. Commit your changes (make sure your commit message concise)
+6. Push your commits to your forked repository
+7. Create a pull request
+
+Please follow [the pull request template](./.github/PULL_REQUEST_TEMPLATE.md).
+Please make sure the PR has a corresponding issue.
+
+After creating a PR, one or more reviewers will be assigned to the pull request.
+The reviewers will review the code.
+
+Before merging a PR, squash any fix review feedback, typo, merged, and rebased sorts of commits.
+The final commit message should be clear and concise.
+
+Thanks for contributing!
+
+### Open an issue / PR
+
+We use [GitHub Issues](https://github.com/jd-opensource/joylive-injector/issues) and [Pull Requests](https://github.com/jd-opensource/joylive-injector/pulls) for trackers.
+
+If you find a typo in document, find a bug in code, or want new features, or want to give suggestions,
+you can [open an issue on GitHub](https://github.com/jd-opensource/joylive-injector/issues/new) to report it.
+Please follow the guideline message in the issue template.
+
+If you want to contribute, please follow the [contribution workflow](#github-workflow) and create a new pull request.
+If your PR contains large changes, e.g. component refactor or new components, please write detailed documents
+about its design and usage.
+
+Note that a single PR should not be too large. If heavy changes are required, it's better to separate the changes
+to a few individual PRs.
+
+### Code review
+
+All code should be well reviewed by one or more committers. Some principles:
+
+- Readability: Important code should be well-documented. Comply with our code style.
+- Elegance: New functions, classes or components should be well designed.
+- Testability: Important code should be well-tested (high unit test coverage).
+
+## Community
+
+### Contact us
+
+#### Slack
+
+Our Slack room: [https://joylivehq.slack.com](https://joylivehq.slack.com).

README-zh.md

@@ -43,3 +43,7 @@ helm repo add joylive https://jd-opensource.github.io/joylive-helm-charts
 kubectl create namespace joylive
 helm install joylive-injector joylive/joylive-injector -n joylive
 ```
+
+## 成员
+
+感谢各位贡献者！[名单](./community/members.md) 

README.md

@@ -43,3 +43,7 @@ helm repo add joylive https://jd-opensource.github.io/joylive-helm-charts
 kubectl create namespace joylive
 helm install joylive-injector joylive/joylive-injector -n joylive
 ```
+
+## Member
+
+Thank you to all the contributors! [Member List](./community/members.md) 

community/members.md

@@ -0,0 +1,18 @@
+See [membership.md](./membership.md) for the definition of these community contributor roles.
+
+### Maintainers
+
+(As of November, 25, 2024)
+
+| Name        | Github ID  | Email               |
+|-------------|------------|---------------------|
+| Xiaofeng He | hexiaofeng | <[email protected]> |
+| Zhiguo Chen | chenzhiguo | <[email protected]> |
+
+### Committers
+
+| Name        | Github ID   | Email                    |
+|-------------|-------------|--------------------------|
+| Zhaoyan Wu  | YanRyan     | <[email protected]>       |
+| Zhichao Xue | zhichao.xue | <[email protected]> |
+

community/membership.md

@@ -0,0 +1,82 @@
+
+| Role | Responsibilities | Requirements |
+| -----| ---------------- | ------------ |
+| Contributor | Participate in the community. | Finish at least one contribution to the project in specific repos. |
+| Active Contributor | Actively contribute to the community. | Have 5 merged PRs or fixed major bugs.|
+| Committer | Accept and approve contributions. | Have a proven track record of contributions and lead major development. Nominees must be approved by a minimum of two votes (excluding the nominator's vote) from the TSC(Technical Steering Committee) members.|
+| Maintainer | Make and approve technical design decisions. Define milestones and releases. Nominate new SIG committers.| Highly experienced committer. Nominees must be approved by a minimum of two votes (excluding the nominator's vote) from the TSC members.|
+
+**Note:** This document is a work in progress.
+This doc outlines the various responsibilities of contributor roles in JoyLive.
+
+## Contributor
+
+Everyone who contributes can become a JoyLive contributor. The members will provide mentorship and guidance when new contributors need assistance.
+
+### How to become a Contributor?
+
+- 1 merged PR (pull request) in JoyLive's repositories
+
+### As a Contributor, we expect you to:
+
+- Actively participate in the development of the JoyLive project
+- Attend community events such as meetups and hackathons
+- Continuously learn about JoyLive-related technologies and share your knowledge with others
+
+### Privileges
+
+- Be recognized as a JoyLive Contributor
+
+## Active Contributor
+
+Active contributors are contributors who have made outstanding contributions and sustained commitment to JoyLive. They actively participate in the community by contributing code, improving docs and helping others.
+
+### How to become an Active Contributor?
+
+- Have at least 5 merged PRs or have fixed major bugs
+- Participate in at least 5 code reviews
+- Actively engage with the community by attending online or offline meetups and participating in community discussions
+
+### Responsibilities and privileges
+
+- Join the community meeting and discussion
+- Mentor and guide new contributors
+- Be recognized as a JoyLive Active Contributor
+
+## Committer
+
+Committers are Contributors who have earned the ability to modify ("commit") source code, documentation or other technical artifacts in a project’s repository.
+
+### How to become a Committer?
+
+- Have a deep understanding of JoyLive's principles and future plans
+- Have the ability to deal with various issues that arise in the project promptly
+- Lead at least one major development, write and revise related documents
+- A contributor may become a Committer by a minimum of two votes (excluding the nominator's vote) from the TSC members.
+
+### Responsibilities and privileges
+
+- Mentor and guide other members in the community
+- Ensure continued health of subproject
+- Be granted write access to JoyLive repos (to be specified)
+- Be recognized as a JoyLive Committer
+
+## Maintainer
+
+Maintainers are a subset of Committers with additional responsibilities for driving a project’s release and serving on the TSC (optional).
+
+### How to become a Maintainer?
+
+- In-depth understanding of JoyLive principles and a clear understanding of JoyLive's future plans
+- Have the ability to deal with project issues promptly
+- Lead project development and iterations, and steer the overall direction of the project
+- A Committer may become a Maintainer by a minimum of two votes (excluding the nominator's vote) from the TSC members.
+
+### Responsibilities and privileges
+
+- Mentor and guide other members in the community
+- Ensure continued health of the project, such as code quality and test coverage
+- Make and approve technical design decisions
+- Define milestones and releases
+- Nominate new SIG committers to TSC
+- Be recognized as a JoyLive Maintainer