From 51a35fc176ed45a8d2d50ad7946f69cf8dcc55d3 Mon Sep 17 00:00:00 2001 From: Yair Chuchem Date: Tue, 10 May 2022 15:52:32 +0300 Subject: [PATCH] Use template from dar5hak/generator-awesome-list As recommended in https://github.com/sindresorhus/awesome/blob/main/create-list.md Didn't override full README and didn't add custom contrib guidelines yet. Further guidelines will be added via lazy evaluation. --- .gitattributes | 2 ++ README.md | 2 +- code-of-conduct.md | 74 ++++++++++++++++++++++++++++++++++++++++++++++ contributing.md | 13 ++++++++ 4 files changed, 90 insertions(+), 1 deletion(-) create mode 100644 .gitattributes create mode 100644 code-of-conduct.md create mode 100644 contributing.md diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..9e25297 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +* text=auto +readme.md merge=union diff --git a/README.md b/README.md index 1989547..baa68d1 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# List of structural editors +# Awesome Structure Editors [![Awesome](https://awesome.re/badge.svg)](https://awesome.re) diff --git a/code-of-conduct.md b/code-of-conduct.md new file mode 100644 index 0000000..a6e07a0 --- /dev/null +++ b/code-of-conduct.md @@ -0,0 +1,74 @@ +# 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 yairchu@gmail.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 [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/contributing.md b/contributing.md new file mode 100644 index 0000000..0ac8438 --- /dev/null +++ b/contributing.md @@ -0,0 +1,13 @@ +# Contribution Guidelines + +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. + +## Updating your PR + +If the maintainers notice anything that we'd like changed, we'll ask you to +edit your PR before we merge it. There's no need to open a new PR, just edit +the existing one. If you're not sure how to do that, +[here is a guide](https://github.com/RichardLitt/knowledge/blob/master/github/amending-a-commit-guide.md) +on the different ways you can update your PR so that we can merge it.