Unverified Commit ddea28bd authored by Yang Libin's avatar Yang Libin Committed by GitHub

docs: add contributing guideline (#26)

parent faced426
# 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, sex characteristics, 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 contact@yanglibin.info. 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
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
# Contributing to Us
Welcome to Doocs! This document is a guideline about how to contribute to qcloud-im-server-sdk-java.
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 1.8 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 `dev` 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
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.
## Community
### Contact us
#### Mailing list
If you have any questions or advice, please send an email to [contact@yanglibin.info](mailto:contact@yanglibin.info).
#### Discussions
https://github.com/doocs/qcloud-im-server-sdk-java/discussions
# Tencent Cloud IM Server SDK in Java
[![license](https://img.shields.io/github/license/doocs/qcloud-im-server-sdk-java?color=42b883&style=flat-square)](./LICENSE)
<a href="https://search.maven.org/artifact/io.github.doocs/im-server-sdk-java"><img src="https://img.shields.io/maven-metadata/v?color=42b883&metadataUrl=https%3A%2F%2Frepo1.maven.org%2Fmaven2%2Fio%2Fgithub%2Fdoocs%2Fim-server-sdk-java%2Fmaven-metadata.xml&style=flat-square" alt="maven"></a>
<a href="https://github.com/doocs/qcloud-im-server-sdk-java/blob/main/LICENSE"><img src="https://img.shields.io/github/license/doocs/qcloud-im-server-sdk-java?color=42b883&style=flat-square" alt="license"></a>
<a href="https://doocs.github.io/#/?id=how-to-join"><img src="https://img.shields.io/badge/organization-join%20us-42b883?style=flat-square" alt="open-source-organization"></a>
## Installation and Getting Started
......@@ -12,7 +14,7 @@ Add the Maven dependency:
<dependency>
<groupId>io.github.doocs</groupId>
<artifactId>im-server-sdk-java</artifactId>
<version>0.0.2</version>
<version>0.0.3</version>
</dependency>
```
......@@ -37,9 +39,9 @@ public class Main {
// import account
AccountImportRequest request = new AccountImportRequest();
request.setFaceUrl("https://avatars.githubusercontent.com/u/21008209?v=4");
request.setIdentifier("ylb");
request.setNick("nickname");
request.setFaceUrl("https://avatars.githubusercontent.com/u/43716716?s=200&v=4");
request.setIdentifier("doocs");
request.setNick("Doocs Community");
try {
AccountImportResult result = client.account.accountImport(request);
System.out.println(result);
......@@ -50,6 +52,10 @@ public class Main {
}
```
## Contributing
Contributions are always welcomed! Please refer to [CONTRIBUTING](./CONTRIBUTING.md) for detailed guidelines.
## License
Apache 2.0 license.
Apache-2.0 License.
......@@ -26,18 +26,21 @@
<name>yanglbme</name>
<email>contact@yanglibin.info</email>
<url>https://github.com/yanglbme</url>
<organization>doocs</organization>
</developer>
<developer>
<id>hongyiheng</id>
<name>hongyiheng</name>
<email>hongyihengg@gmail.com</email>
<url>https://github.com/hongyiheng</url>
<organization>doocs</organization>
</developer>
<developer>
<id>xy</id>
<name>xy</name>
<email>502400992@qq.com</email>
<url>https://github.com/YXxy1002</url>
<organization>doocs</organization>
</developer>
</developers>
......@@ -45,6 +48,10 @@
<name>Doocs Community</name>
<url>https://github.com/doocs</url>
</organization>
<issueManagement>
<system>github</system>
<url>https://github.com/doocs/qcloud-im-server-sdk-java</url>
</issueManagement>
<distributionManagement>
<snapshotRepository>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment