Skip to content

Commit de8364c

Browse files
lotyplotyp
authored
Merge pull request #266 from wayofdev/docs/updates
docs: updating readme
2 parents e2bab8c + b39a817 commit de8364c

File tree

11 files changed

+471
-23
lines changed

11 files changed

+471
-23
lines changed

‎.github/.release-please-config.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"release-type": "php",
33
"packages": {
44
".": {
5-
"package-name": "laravel-package-tpl",
5+
"package-name": "php-cs-fixer-config",
66
"changelog-path": "/CHANGELOG.md"
77
}
88
},

‎.github/CONTRIBUTING.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
To be added...

‎.github/ISSUE_TEMPLATE/1-bug-report.yml‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
---
2+
3+
name: 🐞 Bug Report
4+
description: Report an issue to help the project improve.
5+
title: '[Bug]: '
6+
labels: ['type: bug']
7+
8+
assignees:
9+
- lotyp
10+
11+
body:
12+
- type: markdown
13+
attributes:
14+
value: 🐞 **Bug Report**
15+
16+
- type: textarea
17+
id: bug-description
18+
attributes:
19+
label: Describe the bug
20+
description: Please provide a clear and detailed description of what the bug is. This helps us understand the issue quickly and look for potential fixes.
21+
placeholder: Explain the bug in as much detail as possible...
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: regression
27+
attributes:
28+
label: Is this a regression?
29+
description: |
30+
Was this functionality working in a previous version?
31+
If yes, please mention the last version in which it worked properly.
32+
Understanding regressions helps prioritize fixes.
33+
placeholder: Yes or No, and details about the last working version...
34+
validations:
35+
required: false
36+
37+
- type: textarea
38+
id: steps-to-reproduce
39+
attributes:
40+
label: To Reproduce
41+
description: |
42+
'Please provide step-by-step instructions that reproduce the issue:
43+
1. Use x argument / navigate to...
44+
2. Fill this information...
45+
3. Go to...
46+
4. See error
47+
placeholder: Detailed steps to reproduce the bug...
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
id: expected-behaviour
53+
attributes:
54+
label: Expected behaviour
55+
description: |
56+
Describe what you expected to happen.
57+
Clear expectations help understand the gap between current and desired states.
58+
placeholder: What did you expect to happen instead of the bug?
59+
validations:
60+
required: true
61+
62+
- type: textarea
63+
id: media
64+
attributes:
65+
label: Media prove
66+
description: If applicable, add screenshots or videos to better illustrate the issue. Visual aids can significantly aid in diagnosing problems quicker.
67+
placeholder: Upload files or paste links here...
68+
validations:
69+
required: false
70+
71+
- type: textarea
72+
id: environment
73+
attributes:
74+
label: Your environment
75+
description: |
76+
Provide detailed information about your environment to help us replicate the issue:
77+
* OS: [e.g. Ubuntu]
78+
* PHP version: [e.g. 8.2.2]
79+
* Package version: [e.g. 1.0.0]
80+
* Any relevant environment details
81+
placeholder: List your environment details here...
82+
validations:
83+
required: false
84+
85+
- type: textarea
86+
id: additional-context
87+
attributes:
88+
label: Additional context
89+
description: Include any other context about the problem here, such as unusual system configurations, previous issues, or possible causes.
90+
placeholder: Any additional information that could help us resolve the issue...
91+
validations:
92+
required: false
93+
94+
- type: markdown
95+
attributes:
96+
value: |
97+
📛 To ensure a smooth issue processing, please check if a similar bug report has already been submitted before creating a new one.
98+
We highly value your contributions, so please make sure to familiarize yourself with our repository's guidelines:
99+
- [Code of Conduct](https://github.com/wayofdev/php-cs-fixer-config/blob/master/.github/CODE_OF_CONDUCT.md)
100+
- [Contribution Guidelines](https://github.com/wayofdev/php-cs-fixer-config/blob/master/.github/CONTRIBUTING.md)
101+
102+
Additionally, consider joining our discussions on:
103+
- [WayOfDev Discord Community](https://discord.gg/CE3TcCC5vr)
104+
105+
...

‎.github/ISSUE_TEMPLATE/2-feature-request.yml‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
3+
name: 🚀 Feature Request
4+
description: Suggest an idea or possible new feature for this project.
5+
title: '[Feature]: '
6+
labels: ['type: enhancement']
7+
8+
assignees:
9+
- lotyp
10+
11+
body:
12+
- type: markdown
13+
attributes:
14+
value: 🚀 **Feature Request**
15+
16+
- type: textarea
17+
id: problem-related
18+
attributes:
19+
label: Is your feature request related to a problem? Please describe.
20+
description: |
21+
Please provide a clear and detailed description of what the problem is.
22+
For example, 'I'm always frustrated when...'.
23+
This will help us understand the context and the impact of the problem.
24+
placeholder: Describe the problem...
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
id: desired-solution
30+
attributes:
31+
label: "Describe the solution you'd like"
32+
description: |
33+
What would you like to see happen? Please provide a detailed explanation of the desired feature.
34+
You may include bullet points to outline objectives, key activities, and expected outcomes.
35+
placeholder: |
36+
1. Objective: [What you hope to achieve with this feature]
37+
2. Key Activities: [Steps to implement the feature]
38+
3. Expected Outcome: [Benefits and results of the feature]
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
id: alternative-solutions
44+
attributes:
45+
label: "Describe alternatives you've considered"
46+
description: |
47+
Are there alternative solutions or features you've considered? Please describe them.
48+
Understanding different possible solutions can help in finding the best path forward.
49+
placeholder: Describe any alternative solutions or workarounds you have considered...
50+
validations:
51+
required: false
52+
53+
- type: textarea
54+
id: additional-context
55+
attributes:
56+
label: Additional context
57+
description: |
58+
Add any other context or screenshots about the feature request here.
59+
Links to similar features, or visual aids that support your proposal, if applicable.
60+
placeholder: Insert any additional context or links to similar features here...
61+
validations:
62+
required: false
63+
64+
- type: markdown
65+
attributes:
66+
value: |
67+
📛 To ensure a smooth issue processing, please check if a similar feature request has already been submitted before creating a new one.
68+
We highly value your contributions, so please make sure to familiarize yourself with our repository's guidelines:
69+
- [Code of Conduct](https://github.com/wayofdev/php-cs-fixer-config/blob/master/.github/CODE_OF_CONDUCT.md)
70+
- [Contribution Guidelines](https://github.com/wayofdev/php-cs-fixer-config/blob/master/.github/CONTRIBUTING.md)
71+
72+
Additionally, consider joining our discussions on:
73+
- [WayOfDev Discord Community](https://discord.gg/CE3TcCC5vr)
74+
75+
...

‎.github/ISSUE_TEMPLATE/3-failing-test.yml‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
3+
name: 🧪 Failing Test
4+
description: Report failing tests or CI jobs.
5+
title: '[Test]: '
6+
labels: ['type: test']
7+
8+
assignees:
9+
- lotyp
10+
11+
body:
12+
- type: markdown
13+
attributes:
14+
value: 🧪 **Failing Test**
15+
16+
- type: textarea
17+
id: failing-tests
18+
attributes:
19+
label: Which jobs/test(s) are failing
20+
description: Please specify which CI jobs or tests are failing. Include test names or job identifiers.
21+
placeholder: List the failing jobs or tests here...
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: reason-for-failure
27+
attributes:
28+
label: Reason for failure/description
29+
description: Explain why the test is failing or what might be missing to make it pass. If available, include error messages or output logs.
30+
placeholder: Provide details on why the test is failing, including error logs or output messages...
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
id: media-prove
36+
attributes:
37+
label: Media prove
38+
description: If applicable, add screenshots, videos, or links to logs that help explain the issue. Visual aids can be very helpful in diagnosing problems.
39+
placeholder: Upload files or paste links here...
40+
validations:
41+
required: false
42+
43+
- type: textarea
44+
id: additional-context
45+
attributes:
46+
label: Additional context
47+
description: Add any other context about the problem, such as related issues, recent changes, or environmental specifics that might influence the test outcome.
48+
placeholder: Include any other relevant information that might help understand the issue...
49+
validations:
50+
required: false
51+
52+
- type: markdown
53+
attributes:
54+
value: |
55+
📛 To ensure a smooth issue processing, please check if a similar bug report has already been submitted before creating a new one.
56+
We highly value your contributions, so please make sure to familiarize yourself with our repository's guidelines:
57+
- [Code of Conduct](https://github.com/wayofdev/php-cs-fixer-config/blob/master/.github/CODE_OF_CONDUCT.md)
58+
- [Contribution Guidelines](https://github.com/wayofdev/php-cs-fixer-config/blob/master/.github/CONTRIBUTING.md)
59+
60+
Additionally, consider joining our discussions on:
61+
- [WayOfDev Discord Community](https://discord.gg/CE3TcCC5vr)
62+
63+
...

‎.github/ISSUE_TEMPLATE/4-docs-bug-report.yml‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
3+
name: 📚 Documentation or README.md issue report
4+
description: Report an issue in the project's documentation or README.md file.
5+
title: '[Docs]: '
6+
labels: ['type: documentation', 'type: maintenance']
7+
8+
assignees:
9+
- lotyp
10+
11+
body:
12+
- type: markdown
13+
attributes:
14+
value: 📚 **Documentation Issue Report**
15+
16+
- type: textarea
17+
id: documentation-bug-description
18+
attributes:
19+
label: Describe the bug
20+
description: Provide a clear and concise description of what the error or issue is in the documentation.
21+
placeholder: Explain the issue with the documentation...
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: steps-to-reproduce
27+
attributes:
28+
label: To Reproduce
29+
description: |
30+
Please provide steps to reproduce the error in the documentation:
31+
1. Navigate to the section or URL where the error occurs...
32+
2. Specify the misleading or incorrect information...
33+
3. Suggest what is expected if applicable...
34+
placeholder: |
35+
1. URL or Section...
36+
2. Misleading information...
37+
3. Expected correction...
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: media-prove
43+
attributes:
44+
label: Media prove
45+
description: If applicable, add screenshots or videos to better illustrate the issue with the documentation.
46+
placeholder: Upload files or paste links here...
47+
validations:
48+
required: false
49+
50+
- type: textarea
51+
id: desired-solution
52+
attributes:
53+
label: Describe the solution you would like
54+
description: Describe what changes or improvements you would like to see in the documentation.
55+
placeholder: Describe the desired changes or improvements...
56+
validations:
57+
required: true
58+
59+
- type: textarea
60+
id: additional-context
61+
attributes:
62+
label: Additional context
63+
description: Add any other context or additional information that could help clarify the documentation issue.
64+
placeholder: Provide any additional context here...
65+
validations:
66+
required: false
67+
68+
- type: markdown
69+
attributes:
70+
value: |
71+
📛 To ensure a smooth issue processing, please check if a similar bug report has already been submitted before creating a new one.
72+
We highly value your contributions, so please make sure to familiarize yourself with our repository's guidelines:
73+
- [Code of Conduct](https://github.com/wayofdev/php-cs-fixer-config/blob/master/.github/CODE_OF_CONDUCT.md)
74+
- [Contribution Guidelines](https://github.com/wayofdev/php-cs-fixer-config/blob/master/.github/CONTRIBUTING.md)
75+
76+
Additionally, consider joining our discussions on:
77+
- [WayOfDev Discord Community](https://discord.gg/CE3TcCC5vr)
78+
79+
...

‎.github/ISSUE_TEMPLATE/5-security-report.yml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
3+
name: ⚠️ Security Report
4+
description: Please report security issues directly through GitHub Security Advisories to ensure privacy.
5+
title: '[Security]: '
6+
labels: ['type: bug', 'priority: high', 'type: security']
7+
8+
assignees:
9+
- lotyp
10+
11+
body:
12+
- type: markdown
13+
attributes:
14+
value: >
15+
⚠️ **Please DO NOT report security vulnerabilities here.** Instead, use the GitHub Security Advisories feature to report them privately and securely. This helps us address issues responsibly without exposing them publicly.
16+
17+
- type: markdown
18+
attributes:
19+
value: >
20+
GitHub Advisories do not automatically notify maintainers, so by using the advisories, you help maintain confidentiality while ensuring the issue is documented and tracked properly.
21+
22+
- type: markdown
23+
attributes:
24+
value: 'To create a new advisory, go to: [Create Security Advisory](https://github.com/wayofdev/php-cs-fixer-config/security/advisories/new)'
25+
26+
- type: textarea
27+
id: github-advisory-url
28+
attributes:
29+
label: Your GitHub Advisory URL
30+
description: Optionally, you can paste the URL of the GitHub Security Advisory you have created here for reference.
31+
placeholder: Paste the GitHub Security Advisory URL here...
32+
validations:
33+
required: false
34+
35+
...

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
3+
blank_issues_enabled: true
4+
5+
contact_links:
6+
- name: Start a discussion or ask a question.
7+
url: https://github.com/wayofdev/.github/discussions
8+
about: Please ask and answer questions here.
9+
10+
- name: Join our Discord Community
11+
url: https://discord.gg/CE3TcCC5vr
12+
about: Join our Discord community to get help, share your ideas, and chat with other developers.
13+
14+
...

0 commit comments

Comments
 (0)