From 3bad96aa4256bc9b2afec371cec70ec27516a7ed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Rancoud?= Date: Sun, 3 Mar 2024 19:54:20 +0100 Subject: [PATCH] chore: update community files --- .github/CODE_OF_CONDUCT.md | 76 ------------ .github/ISSUE_TEMPLATE/bug_report.md | 28 ++--- .github/ISSUE_TEMPLATE/feature_request.md | 20 ++-- .github/PULL_REQUEST_TEMPLATE.md | 28 ++--- .github/SUPPORT.md | 27 ----- CODE_OF_CONDUCT.md | 128 +++++++++++++++++++++ .github/CONTRIBUTING.md => CONTRIBUTING.md | 17 ++- SECURITY.md | 13 +++ 8 files changed, 178 insertions(+), 159 deletions(-) delete mode 100644 .github/CODE_OF_CONDUCT.md delete mode 100644 .github/SUPPORT.md create mode 100644 CODE_OF_CONDUCT.md rename .github/CONTRIBUTING.md => CONTRIBUTING.md (70%) create mode 100644 SECURITY.md diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md deleted file mode 100644 index 77829f9..0000000 --- a/.github/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,76 +0,0 @@ -# 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 on Twitter @rancoud. 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 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index ee74244..d48e2ea 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,34 +1,28 @@ --- name: Bug report about: Create a report to help us improve -title: "[BUG]" -labels: bug +title: "[BUG] " +labels: "bug" assignees: rancoud --- ## Description -> A clear and concise description of what the bug is. + ## Steps to reproduce this issue -1. -2. -3. -4. +1. +2. +3. +4. ## Expected behavior -> A clear and concise description of what you expected to happen. + ## Actual behavior -> A clear and concise description of what you actual have instead of expected behavior. + ## Screenshots -> If applicable, add screenshots to help explain your problem. - -## Versions -> Please complete the following information - - OS: [e.g. Windows 10] - - PHP Version: [e.g. 7.4.0] - - Lib Version: [e.g. 1.0.0] + ## Additional context -> Add any other context about the problem here. \ No newline at end of file + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 9a05b4c..6227d75 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,23 +1,23 @@ --- name: Feature request -about: Suggest an idea for this project -title: "[FEATURE]" -labels: enhancement +about: Suggest an idea +title: "[FEATURE] " +labels: "enhancement" assignees: rancoud --- ## My problem -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + ## My suggestion -**Describe the solution you'd like** -A clear and concise description of what you want to happen. + ## Alternatives -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. + ## Additional context -Add any other context or screenshots about the feature request here. \ No newline at end of file + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 3f36a4f..1bc6936 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,19 +1,9 @@ -> Thanks for contributing! -> Before submitting a pull request, please complete the following checklist: -> - [ ] For any new features or bug fixes, both positive and negative test cases have been added. -> - [ ] For any new features, documentation has been added. -> - [ ] Link issue related to this pull request with keyword `closes` ([documentation about keywords](https://docs.github.com/en/enterprise/2.16/user/github/managing-your-work-on-github/closing-issues-using-keywords)) -> - [ ] Search previous suggestions before making a new one, as yours may be a duplicate. - -**You MUST delete the content above including this line before posting, otherwise your pull request will be invalid.** - -## Description -> Describe your changes here. - -## Changelist -- Change 1 -- Change 2 -- Change 3 - -## Issue -> Issue related here closes #123 \ No newline at end of file + +# Description diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md deleted file mode 100644 index 0e85f25..0000000 --- a/.github/SUPPORT.md +++ /dev/null @@ -1,27 +0,0 @@ -# Support -First, [be a good guy](https://github.com/kossnocorp/etiquette/blob/master/README.md). - -## Reporting an issue -Please do a search in [open issues](https://github.com/rancoud/pagination/issues?utf8=%E2%9C%93&q=) to see if the issue or feature request has already been filed. - -If you find your issue already exists, make relevant comments and add your [reaction](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments). Use a reaction in place of a "+1" comment. - -:+1: - upvote - -:-1: - downvote - -If you cannot find an existing issue that describes your bug or feature, submit an issue using the guidelines below. - -## Writing good bug reports and feature requests -File a single issue per problem and feature request. - -* Do not enumerate multiple bugs or feature requests in the same issue. -* Do not add your issue as a comment to an existing issue unless it's for the identical input. Many issues look similar, but have different causes. - -The more information you can provide, the more likely someone will be successful reproducing the issue and finding a fix. - -You are now ready to [create a new issue](https://github.com/rancoud/pagination/issues/new/choose)! - -## Closure policy -* Issues that don't have the information requested above (when applicable) will be closed immediately and the poster directed to the support guidelines. -* Issues that go a week without a response from original poster are subject to closure at my discretion. \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..00b4e3f --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible 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. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders 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, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +contact@rancoud.com. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. diff --git a/.github/CONTRIBUTING.md b/CONTRIBUTING.md similarity index 70% rename from .github/CONTRIBUTING.md rename to CONTRIBUTING.md index e930d3e..0258e3d 100644 --- a/.github/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,18 +2,15 @@ Hi there! I'm thrilled that you'd like to contribute to this project. Your help is essential for keeping it great. -Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](../LICENSE). +Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE). ## Submitting a pull request -1. [Fork](https://github.com/rancoud/pagination/fork) and clone the repository -2. Configure and install the dependencies: `composer install` -3. Create a new branch: `git checkout -b my-branch-name` -4. Make your change -5. Lint your files: `composer lint` -6. Test your code: `composer test` -7. Push to your fork and [submit a pull request](https://github.com/rancoud/pagination/compare) -8. Pat your self on the back and wait for your pull request to be reviewed and merged. +1. [Fork](https://github.com/rancoud/Pagination/fork) and clone the repository +2. Create a new branch: `git checkout -b my-branch-name` +3. Make your change +4. Push to your fork and [submit a pull request](https://github.com/rancoud/Pagination/compare) +5. Pat your self on the back and wait for your pull request to be reviewed and merged. Here are a few things you can do that will increase the likelihood of your pull request being accepted: @@ -26,4 +23,4 @@ Here are a few things you can do that will increase the likelihood of your pull * [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) * [Using Pull Requests](https://help.github.com/articles/about-pull-requests/) -* [GitHub Help](https://help.github.com) \ No newline at end of file +* [GitHub Help](https://help.github.com) diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..9b044b8 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,13 @@ +# Security Policy + +## Reporting a Vulnerability + +The project maintainers take security seriously. If you discover a security +issue, please bring it to their attention right away! + +**Please _DO NOT_ file a public issue**, instead send your report privately to +contact@rancoud.com . + +Security reports are greatly appreciated. + +We currently do not offer a paid security bounty program.