Skip to content

Commit

Permalink
feat(docs): fix CODEOWNERS, add CODE_OF_CONDUCT & CONTRIBUTING (mistw…
Browse files Browse the repository at this point in the history
  • Loading branch information
gorillamoe authored and iamxiaojianzheng committed Oct 24, 2024
1 parent d2f6395 commit 366be8b
Show file tree
Hide file tree
Showing 4 changed files with 175 additions and 1 deletion.
1 change: 0 additions & 1 deletion .github/CODEOWNERS

This file was deleted.

1 change: 1 addition & 0 deletions CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @gorillamoe @Grueslayer
85 changes: 85 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to make 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 includes 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 an individual maintainer on:

### GitHub

- @gorillamoe

> (at `GitHub username` + `@github.com`).
### Discord

- gorillamoe

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://contributor-covenant.org/version/1/4][version]

[homepage]: https://contributor-covenant.org
[version]: https://contributor-covenant.org/version/1/4/
89 changes: 89 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
# Contributing to Kulala

Thanks for checking out Kulala!
We're excited to hear and learn from you.

We've put together the following guidelines to
help you figure out where you can best be helpful.

## Table of Contents

0. [Types of contributions we're looking for](#types-of-contributions-were-looking-for)
0. [Ground rules & expectations](#ground-rules--expectations)
0. [How to contribute](#how-to-contribute)
0. [Style guide](#style-guide)
1. [Documentation](#documentation)
2. [Code](#code)
0. [Setting up your environment](#setting-up-your-environment)
0. [Community](#community)

## Types of contributions we're looking for

There are many ways you can directly contribute to Kulala:

- Feature requests
- Bug reports
- Code contributions
- Writing or editing documentation

## Ground rules & expectations

Before we get started,
here are a few things we expect from you (and that you should expect from others):

- Be kind and thoughtful in your conversations around this project.
We all come from different backgrounds and projects,
which means we likely have different perspectives on "how open source is done."
Try to listen to others rather than convince them that your way is correct.
- Kulala is released with a [Contributor Code of Conduct](./CODE_OF_CONDUCT.md).
By participating in this project, you agree to abide by its terms.
- Please ensure that your contribution passes all tests if you open a pull request.
If there are test failures, you will need to address them before we can merge your contribution.
- When adding content, please consider if it is widely valuable.
Please don't add references or links to things you or your employer have created,
as others will do so if they appreciate it.

## How to contribute

If you'd like to contribute,
start by searching through the [pull requests](https://github.com/mistweaverco/kulala.nvim/pulls) to
see whether someone else has raised a similar idea or question.

If you don't see your idea listed, and you think it fits into the goals of this guide, open a pull request.

## Style guide

### Documentation

If you're writing documentation,
see the [style guide](./docs/.vale/styles) (which uses [vale](https://vale.sh)) to
help your prose match the rest of the documentation.

### Code

When writing code,
please follow these configurations:

- [styllua](./stylua.toml)
- [luacheck](./.luacheckrc)
- [EditorConfig](./.editorconfig)
- [yaml-lint](./.yamllint.yaml)

Most of them are automatically checked by the CI,
so you don't need to worry about them.

## Community

Discussions about the Kulala take place on:

- This repository's [Issues](https://github.com/mistweaverco/kulala.nvim/issues) and
[Pull Requests](https://github.com/mistweaverco/kulala.nvim/pulls) sections
- The [Kulala Discord server](https://discord.gg/QyVQmfY4Rt)

Anybody is welcome to join these conversations.

Wherever possible,
do not take these conversations to private channels,
including contacting the maintainers directly.

Keeping communication public means everybody can benefit and learn from the conversation.

0 comments on commit 366be8b

Please sign in to comment.