Skip to content

Commit

Permalink
chore: update community files
Browse files Browse the repository at this point in the history
  • Loading branch information
rancoud committed Mar 3, 2024
1 parent d3e4e49 commit 65b141a
Show file tree
Hide file tree
Showing 8 changed files with 178 additions and 159 deletions.
76 changes: 0 additions & 76 deletions .github/CODE_OF_CONDUCT.md

This file was deleted.

28 changes: 11 additions & 17 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -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.
<!-- 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.
<!-- 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.
<!-- 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]
<!-- If applicable, add screenshots to help explain your problem. -->

## Additional context
> Add any other context about the problem here.
<!-- Add any other context about the problem here. -->
20 changes: 10 additions & 10 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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 [...]
<!-- **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.
<!-- **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.
<!-- **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.
<!-- Add any other context or screenshots about the feature request here. -->
28 changes: 9 additions & 19 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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
<!--
Thanks for sending a pull request!
Here are some tips for you:
1. If this PR is still in in Progress, put it in draft.
2. If this PR is introducing a breaking change please prefix with *BREAKING* in PR title.
3. If this PR has any follow up tasks, please prefix with *TODO* and describe follow up task.
4. When PR is ready to be reviewed, please tag rancoud as a sole reviewer.
-->
# Description
27 changes: 0 additions & 27 deletions .github/SUPPORT.md

This file was deleted.

128 changes: 128 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -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.
17 changes: 7 additions & 10 deletions .github/CONTRIBUTING.md → CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/model/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/model/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/Model/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/Model/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:

Expand All @@ -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)
* [GitHub Help](https://help.github.com)
13 changes: 13 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 65b141a

Please sign in to comment.