Skip to content

Commit ee7c5b7

Browse files
committed
Add .github folder
- Add Issue templates - Add Pull request - Add Code of conduct - Add Contributing - Add Security
1 parent 452f336 commit ee7c5b7

File tree

6 files changed

+351
-0
lines changed

6 files changed

+351
-0
lines changed

.github/CODE_OF_CONDUCT.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

.github/CONTRIBUTING.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# Contributing
2+
3+
> I welcome feature requests and bug reports. Please read these guidelines before submitting one.
4+
5+
From opening a bug report to creating a pull request: every contribution is appreciated and welcomed.
6+
7+
# Your first Contribution
8+
9+
First of all, you will need to create an issue in Github for the feature or bugfix that you want to work on. When you open a new issue, there will be a template that will be automatically added to the text of the issue, which you would need to fill in. Doing this will help us to understand better what the ticket is about.
10+
11+
After you've created the issue, we will have a look, and provide feedback to your ticket.
12+
13+
In case it is a bug that you want to fix, we might help you with background information about the issue, so you can make an informed fix.
14+
15+
Words that begin with the at sign (@) must be wrapped in backticks! . As a courtesy to avoid sending notifications to any user that might have the @username being referenced, please remember that GitHub usernames also start with the at sign.
16+
17+
If you don't wrap them in backticks, users will get unintended notifications from you.
18+
19+
In case you are suggesting a new feature, we will match your idea with our current roadmap, and will open conversations about it. Once the discussion has been done, and the tasks cleared, then you're ready to code.
20+
21+
GitHub has other great markdown features as well, go [here](https://help.github.com/categories/writing-on-github/) to learn more about them.
22+
23+
# Reporting Issues
24+
25+
Most of the time, when webpack does not work correctly, it might be a configuration issue.
26+
27+
If you are still having difficulty after looking over your configuration carefully, please post a question to [StackOverflow with the MVC tag](http://stackoverflow.com/tags/autoloader). This way you help others to help you.
28+
29+
> You should also have Google search and other plattforms included.
30+
31+
**If you have discovered a bug or have a feature suggestion, feel free to create an issue on Github.**
32+
33+
It can happen again and again that mistakes have crept in and the code does not work smoothly. That's why you can open a ticket here and get help. However, it should be checked beforehand if someone already had this error and he was already helped.
34+
35+
### Creating branch
36+
37+
Making a branch in your fork for your contribution is helpful in the following ways:
38+
39+
* It allows you to submit more than one contribution in a single PR.
40+
* It allows us to identify what your contribution is about from the branch name.
41+
42+
You will want to checkout the `main` branch locally before creating your new branch.
43+
44+
There are two types of branches:
45+
46+
* Feature
47+
* Bugfix
48+
49+
### Features
50+
51+
If your contribution is something new, like an option for the cli, you can create a branch with the following prefix:
52+
53+
`feature/<the-new-feature>`
54+
55+
### Fixes
56+
57+
If you are fixing an existing bug, you can create a branch with the following prefix:
58+
59+
`bugfix/<the-fix>`
60+
61+
### Testing
62+
63+
Any bug fix or feature you submit needs to be tested. Writing tests for code is very important to avoid future errors and to immediately detect potential new errors.
64+
65+
It's important that you test the logic of the code you're writing, and that your tests really go through all the lines, branches, and instructions. Only in this way can it be ensured that the code coverage is high enough to ensure that the users of the generator use a solid tool.
66+
67+
If you need help or need advice on writing your tests, please contact us. We would like to point you in the right direction.
68+
69+
Write here your [issues](https://github.com/prod3v3loper/php-auto-autoloader/issues).
70+
71+
# Pull Requests
72+
73+
After receiving some feedback, press down on your fork and submit a pull request. We can suggest some changes, improvements or implementation alternatives.
74+
75+
Create a new industry as described above.
76+
77+
If you made a small change in most cases, your pull request will be accepted faster.
78+
79+
### Submitting a good Pull Request
80+
81+
* Test before submit
82+
* Follow our code convention
83+
* Write a good commit message
84+
85+
Show all [pulls](https://github.com/prod3v3loper/php-auto-autoloader/pulls).
Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
name: Bug Report
2+
description: Report a bug
3+
title: "[Bug]: "
4+
labels: ["bug", "triage"]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to fill out this bug report!
11+
12+
- type: input
13+
attributes:
14+
label: Contact Details
15+
description: |
16+
How can we get in touch with you if we need more info?
17+
placeholder: ex. email@example.com
18+
validations:
19+
required: false
20+
21+
- type: textarea
22+
attributes:
23+
label: What happened?
24+
description: |
25+
Also tell us, what did you expect to happen?
26+
placeholder: A bug happened! Tell us what happend?
27+
validations:
28+
required: true
29+
30+
- type: textarea
31+
attributes:
32+
label: Steps to reproduce the behavior!
33+
description: |
34+
A clear and concise description of what you expected to happen.
35+
value: "1. Go to '...'
36+
2. Click on '....'
37+
3. Scroll down to '....'
38+
4. See error"
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
attributes:
44+
label: Device and information
45+
description: |
46+
A description of your device and their informations
47+
value: "- OS: [e.g. iOS]
48+
- Browser [e.g. chrome, safari]
49+
- Version [e.g. 22]
50+
- Device: [e.g. iPhone6]"
51+
validations:
52+
required: true
53+
54+
- type: textarea
55+
attributes:
56+
label: Relevant log output
57+
description: |
58+
Please copy and paste any relevant log output.
59+
This will be automatically formatted into code, so no need for backticks.
60+
render: bash
61+
validations:
62+
required: false
63+
64+
- type: checkboxes
65+
attributes:
66+
label: Code of Conduct
67+
description: |
68+
By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/prod3v3loper/php-auto-autoloader/blob/main/.github/CODE_OF_CONDUCT.md)
69+
options:
70+
- label: I agree to follow this project's Code of Conduct
71+
required: true
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: Feature Request
2+
description: Suggest an idea to help us improve
3+
title: "[Feature]: "
4+
labels: ["feature", "enhancement"]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to fill out this feature request!
11+
12+
- type: input
13+
attributes:
14+
label: Contact Details
15+
description: |
16+
How can we get in touch with you if we need more info?
17+
placeholder: ex. email@example.com
18+
validations:
19+
required: false
20+
21+
- type: textarea
22+
attributes:
23+
label: Description of feature!
24+
description: |
25+
Is your feature request related to a problem?
26+
A clear and concise description of what the problem is.
27+
placeholder: Ex. I'm always frustrated when [...]
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
attributes:
33+
label: Suggested Solution
34+
description: |
35+
Describe the solution you'd like!
36+
A clear and concise description of what you want to happen.
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
attributes:
42+
label: Alternatives
43+
description: |
44+
Describe alternatives you've considered.
45+
A clear and concise description of any alternative solutions or features you've considered.
46+
validations:
47+
required: false
48+
49+
- type: textarea
50+
attributes:
51+
label: Additional Context
52+
description: |
53+
Add any other context about the problem here.
54+
validations:
55+
required: false
56+
57+
- type: checkboxes
58+
attributes:
59+
label: Code of Conduct
60+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/prod3v3loper/php-auto-autoloader/blob/main/.github/CODE_OF_CONDUCT.md)
61+
options:
62+
- label: I agree to follow this project's Code of Conduct
63+
required: true
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Description
2+
3+
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
4+
5+
Fixes # (issue)
6+
7+
## Type of change
8+
9+
Please fill options that are relevant with [x].
10+
11+
- [ ] Bug fix (non-breaking change which fixes an issue)
12+
- [ ] New feature (non-breaking change which adds functionality)
13+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14+
- [ ] This change requires a documentation update
15+
16+
# How Has This Been Tested?
17+
18+
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
19+
20+
- [ ] Test A
21+
- [ ] Test B
22+
23+
**Test Configuration**:
24+
* Node version:
25+
* NPM version:
26+
* Webpack version:
27+
* Yeoman version:
28+
29+
# Checklist
30+
31+
Please fill in everything that was done
32+
33+
- [ ] My code follows the style guidelines of this project
34+
- [ ] I have performed a self-review of my own code
35+
- [ ] I have commented my code, particularly in hard-to-understand areas
36+
- [ ] I have made corresponding changes to the documentation
37+
- [ ] My changes generate no new warnings
38+
- [ ] I have added tests that prove my fix is effective or that my feature works
39+
- [ ] New and existing unit tests pass locally with my changes
40+
- [ ] Any dependent changes have been merged and published in downstream modules

.github/SECURITY.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
We only support the latest version.
6+
7+
| Version | Supported |
8+
| -------------- | ------------------ |
9+
| x.x.x latest | :white_check_mark: |
10+
| 5.0.x | :x: |
11+
| 4.0.x | :x: |
12+
| < 4.0 | :x: |
13+
14+
## Reporting a Vulnerability
15+
16+
For more information lokk at [GitHub docs](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability).

0 commit comments

Comments
 (0)