Skip to content

Commit cb5c0e0

Browse files
author
Arthur Jen
committed
Prepare for open source
1 parent 7d5d129 commit cb5c0e0

9 files changed

+352
-62
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
name: Bug Report
3+
about: Use this template to report a bug.
4+
title: "[DESCRIPTIVE BUG NAME]"
5+
labels: 🐛 Bug Report, 🔍 Needs Triage
6+
---
7+
8+
### ✅ Prerequisites
9+
10+
- [ ] Did you perform a cursory search of open issues? Is this bug already reported elsewhere?
11+
- [ ] Are you running the latest SDK version?
12+
- [ ] Are you reporting to the correct repository (`magic-admin-php`)?
13+
14+
### 🐛 Description
15+
16+
[Description of the bug.]
17+
18+
### 🧩 Steps to Reproduce
19+
20+
1. [First Step]
21+
2. [Second Step]
22+
3. [and so on...]
23+
24+
### 🤔 Expected behavior
25+
26+
[What you expected to happen?]
27+
28+
### 😮 Actual behavior
29+
30+
[What actually happened? Please include any error stack traces you encounter.]
31+
32+
### 💻 Code Sample
33+
34+
[If possible, please provide a code repository, gist, code snippet or sample files to reproduce the issue.]
35+
36+
### 🌎 Environment
37+
38+
| Software | Version(s) |
39+
| ------------------- | ---------- |
40+
| `magic-admin-php` | |
41+
| `php` | |
42+
| Operating System | |

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Feature Request
3+
about: Use this template to request a new feature.
4+
title: "[DESCRIPTIVE FEATURE NAME]"
5+
labels: ✨Feature Request
6+
---
7+
8+
### ✅ Prerequisites
9+
10+
- [ ] Did you perform a cursory search of open issues? Is this feature already requested elsewhere?
11+
- [ ] Are you reporting to the correct repository (`magic-admin-php`)?
12+
13+
### ✨ Feature Request
14+
15+
[Description of the feature.]
16+
17+
## 🧩 Context
18+
19+
[Explain any additional context or rationale for this feature. What are you trying to accomplish?]
20+
21+
## 💻 Examples
22+
23+
[Do you have any example(s) for the requested feature? If so, describe/demonstrate your example(s) here.]

‎.github/ISSUE_TEMPLATE/question.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Question
3+
about: Use this template to request help or ask a question.
4+
title: "[WHAT'S YOUR QUESTION?]"
5+
labels: ❓Question
6+
---
7+
8+
### ✅ Prerequisites
9+
10+
- [ ] Did you perform a cursory search of open issues? Is this question already asked elsewhere?
11+
- [ ] Are you reporting to the correct repository (`magic-admin-php`)?
12+
13+
### ❓ Question
14+
15+
[Ask your question here, please be as detailed as possible!]
16+
17+
### 🌎 Environment
18+
19+
| Software | Version(s) |
20+
| ------------------- | ---------- |
21+
| `magic-admin-php` | |
22+
| `php` | |
23+
| Operating System | |

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
### 📦 Pull Request
2+
3+
[Provide a general summary of the pull request here.]
4+
5+
### 🗜 Versioning
6+
7+
(Check _one!_)
8+
9+
- [ ] Patch: Bug Fix?
10+
- [ ] Minor: New Feature?
11+
- [ ] Major: Breaking Change?
12+
13+
### ✅ Fixed Issues
14+
15+
- [List any fixed issues here like: Fixes #XXXX]
16+
17+
### 🚨 Test instructions
18+
19+
[Describe any additional context required to test the PR/feature/bug fix.]
20+
21+
### ⚠️ Update `CHANGELOG.md`
22+
23+
- [ ] I have updated the `Upcoming Changes` section of `CHANGELOG.md` with context related to this Pull Request.

‎CHANGELOG.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## Upcoming Changes
2+
3+
#### Fixed
4+
5+
- <PR-#ISSUE> ...
6+
7+
#### Changed
8+
9+
- <PR-#ISSUE> ...
10+
11+
#### Added
12+
13+
- <PR-#ISSUE> ...

‎CONTRIBUTING.md

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

‎LICENSE renamed to ‎LICENSE.txt

File renamed without changes.

0 commit comments

Comments
 (0)