Skip to content

Commit 37892e0

Browse files
rancoudrancoud
authored
chore: update community files (#185)
1 parent a746bf3 commit 37892e0

File tree

8 files changed

+178
-159
lines changed

8 files changed

+178
-159
lines changed

‎.github/CODE_OF_CONDUCT.md‎

Lines changed: 0 additions & 76 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,28 @@
11
---
22
name: Bug report
33
about: Create a report to help us improve
4-
title: "[BUG]"
5-
labels: bug
4+
title: "[BUG] "
5+
labels: "bug"
66
assignees: rancoud
77

88
---
99
## Description
10-
> A clear and concise description of what the bug is.
10+
<!-- A clear and concise description of what the bug is. -->
1111

1212
## Steps to reproduce this issue
13-
1.
14-
2.
15-
3.
16-
4.
13+
1.
14+
2.
15+
3.
16+
4.
1717

1818
## Expected behavior
19-
> A clear and concise description of what you expected to happen.
19+
<!-- A clear and concise description of what you expected to happen. -->
2020

2121
## Actual behavior
22-
> A clear and concise description of what you actual have instead of expected behavior.
22+
<!-- A clear and concise description of what you actual have instead of expected behavior. -->
2323

2424
## Screenshots
25-
> If applicable, add screenshots to help explain your problem.
26-
27-
## Versions
28-
> Please complete the following information
29-
- OS: [e.g. Windows 10]
30-
- PHP Version: [e.g. 7.4.0]
31-
- Lib Version: [e.g. 1.0.0]
25+
<!-- If applicable, add screenshots to help explain your problem. -->
3226

3327
## Additional context
34-
> Add any other context about the problem here.
28+
<!-- Add any other context about the problem here. -->

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
---
22
name: Feature request
3-
about: Suggest an idea for this project
4-
title: "[FEATURE]"
5-
labels: enhancement
3+
about: Suggest an idea
4+
title: "[FEATURE] "
5+
labels: "enhancement"
66
assignees: rancoud
77

88
---
99

1010
## My problem
11-
**Is your feature request related to a problem? Please describe.**
12-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
<!-- **Is your feature request related to a problem? Please describe.**
12+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
1313

1414
## My suggestion
15-
**Describe the solution you'd like**
16-
A clear and concise description of what you want to happen.
15+
<!-- **Describe the solution you'd like**
16+
A clear and concise description of what you want to happen. -->
1717

1818
## Alternatives
19-
**Describe alternatives you've considered**
20-
A clear and concise description of any alternative solutions or features you've considered.
19+
<!-- **Describe alternatives you've considered**
20+
A clear and concise description of any alternative solutions or features you've considered. -->
2121

2222
## Additional context
23-
Add any other context or screenshots about the feature request here.
23+
<!-- Add any other context or screenshots about the feature request here. -->

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 9 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,9 @@
1-
> Thanks for contributing!
2-
> Before submitting a pull request, please complete the following checklist:
3-
> - [ ] For any new features or bug fixes, both positive and negative test cases have been added.
4-
> - [ ] For any new features, documentation has been added.
5-
> - [ ] 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))
6-
> - [ ] Search previous suggestions before making a new one, as yours may be a duplicate.
7-
8-
**You MUST delete the content above including this line before posting, otherwise your pull request will be invalid.**
9-
10-
## Description
11-
> Describe your changes here.
12-
13-
## Changelist
14-
- Change 1
15-
- Change 2
16-
- Change 3
17-
18-
## Issue
19-
> Issue related here closes #123
1+
<!--
2+
Thanks for sending a pull request!
3+
Here are some tips for you:
4+
1. If this PR is still in in Progress, put it in draft.
5+
2. If this PR is introducing a breaking change please prefix with *BREAKING* in PR title.
6+
3. If this PR has any follow up tasks, please prefix with *TODO* and describe follow up task.
7+
4. When PR is ready to be reviewed, please tag rancoud as a sole reviewer.
8+
-->
9+
# Description

‎.github/SUPPORT.md‎

Lines changed: 0 additions & 27 deletions
This file was deleted.

‎CODE_OF_CONDUCT.md‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[email protected].
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

.github/CONTRIBUTING.md renamed to CONTRIBUTING.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,15 @@
22

33
Hi there! I'm thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
44

5-
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).
5+
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).
66

77
## Submitting a pull request
88

9-
1. [Fork](https://github.com/rancoud/session/fork) and clone the repository
10-
2. Configure and install the dependencies: `composer install`
11-
3. Create a new branch: `git checkout -b my-branch-name`
12-
4. Make your change
13-
5. Lint your files: `composer lint`
14-
6. Test your code: `composer test`
15-
7. Push to your fork and [submit a pull request](https://github.com/rancoud/session/compare)
16-
8. Pat your self on the back and wait for your pull request to be reviewed and merged.
9+
1. [Fork](https://github.com/rancoud/Session/fork) and clone the repository
10+
2. Create a new branch: `git checkout -b my-branch-name`
11+
3. Make your change
12+
4. Push to your fork and [submit a pull request](https://github.com/rancoud/Session/compare)
13+
5. Pat your self on the back and wait for your pull request to be reviewed and merged.
1714

1815
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
1916

@@ -26,4 +23,4 @@ Here are a few things you can do that will increase the likelihood of your pull
2623

2724
* [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
2825
* [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
29-
* [GitHub Help](https://help.github.com)
26+
* [GitHub Help](https://help.github.com)

‎SECURITY.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
The project maintainers take security seriously. If you discover a security
6+
issue, please bring it to their attention right away!
7+
8+
**Please _DO NOT_ file a public issue**, instead send your report privately to
9+
[email protected] .
10+
11+
Security reports are greatly appreciated.
12+
13+
We currently do not offer a paid security bounty program.

0 commit comments

Comments
 (0)