Skip to content

Commit

Permalink
coc and contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AnirudhG07 committed Jul 6, 2024
1 parent f92fcc3 commit 706bce5
Show file tree
Hide file tree
Showing 2 changed files with 108 additions and 1 deletion.
70 changes: 70 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# 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. 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 [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
39 changes: 38 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,40 @@
# Contribution Guidelines

-- TODO
Please note that this project is released with a [Contributor Code of Conduct](CODE-OF-CONDUCT.md). By participating in this project, you agree to abide by its terms.

## Table of Contents

- [Pull Request Guidelines](#pull-request-guidelines)
- [How to add to this list](#how-to-add-to-this-list)
- [Updating your Pull Request](#updating-your-pull-request)

## Pull Request Guidelines

Please ensure your pull request adheres to the following guidelines:

- Search previous suggestions to make sure your suggestion isn't a duplicate.
- Make sure each list item is useful before adding it.
- Create individual pull requests/issues for each suggestion.
- Use [title-casing](http://titlecapitalization.com) (AP style) in the following format: `[List Name](link)`
- Link additions should be added in alphabetical order in the relevant category.
- New categories or changes to the existing categorization are welcome.
- Check your spelling and grammar.
- Make sure your text editor is set to remove trailing whitespace.
- The pull request and commit should have a useful title.
- Annotate your PR to clarify what you did if the diff is confusing.

Thank you for your suggestions!

## How to add to this list

If you would like to add a plugin, flavor, etc. of yazi to the list, here is how you should do it -

1. Fork the repository
2. Edit the Readme ensuring the PR Guidelines are being followed
3. Update the Table of Contents (if needed)
4. Commit and create a PR with its name and content abiding by the PR Guidelines

## Updating your Pull Request

If you are asked to edit your PR due to spelling errors or because your PR didn't match the awesome-yazi list guidelines, please make suitable changes in your fork.
This will automatically be reflected in the PR for further checking.

0 comments on commit 706bce5

Please sign in to comment.