Skip to content

Commit

Permalink
update readme, code of conduct, issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
medcl committed Oct 31, 2023
1 parent 1b69302 commit cb04ca4
Show file tree
Hide file tree
Showing 5 changed files with 105 additions and 2 deletions.
2 changes: 0 additions & 2 deletions .github/FUNDING.yml

This file was deleted.

30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: Bug report
about: Create a bug report to help fix a problem
---

### Description

A description of what the bug is.

### Steps to reproduce

1. First step
2. Second step
3. Third step

Priovde your configuration or code snippet that helps.

### Expected behavior

A description of what you expected to happen.

### Actual behavior

A description of what happens instead.

### Environment

- Versions: [e.g. Elasticsearch 8.0.0]
- Operating system and version: [e.g. macOS 10.14, Windows 10, Ubuntu 18.04]
- [Linux] Desktop Environment and/or Window Manager: [e.g. Gnome, LXDE, i3]
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement_or_feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Enhancement or feature request
about: Suggest an enhancement or feature
---

### Problem description

A description of a problem, workflow or integration that your suggestion would solve.
If the problem is OS-specific, include that information here.

### Preferred solution

A description of what changes should be made to solve the problem.

### Alternatives

A description of any alternative solutions or enhancements considered.

### Additional Information (optional)

If applicable, add screenshots to help demonstrate the problem or proposed solution.
Code examples or related links are useful, too.
46 changes: 46 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# 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, 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@infini.ltd. The project team will review and investigate all complaints, and will respond in a way that it deems 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 [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ This Pinyin Analysis plugin is used to do conversion between Chinese characters
| 1.2.2 | 1.0.x |
--------------------------------------------------

> If some version was not released in time, instead of request version by raising issue, please kindly reach out by join this discord channel( [https://discord.gg/NtZgghfW](https://discord.gg/NtZgghfW)).

The plugin includes analyzer: `pinyin` , tokenizer: `pinyin` and token-filter: `pinyin`.

** Optional Parameters **
Expand Down Expand Up @@ -376,3 +379,7 @@ GET /medcl3/_search
</pre>

8.That's all, have fun.

# Community

[https://discord.gg/NtZgghfW](https://discord.gg/NtZgghfW)

0 comments on commit cb04ca4

Please sign in to comment.