Skip to content

Commit 7827308

Browse files
GabrielPalacGabrielPalac
authored
Merge pull request #73 from lion-packages/documentation
Documentation
2 parents d1f4556 + 583bd1f commit 7827308

File tree

3 files changed

+175
-0
lines changed

3 files changed

+175
-0
lines changed

‎CODE_OF_CONDUCT.md

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

‎CONTRIBUTING.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
2+
# Contributing to Lion-Packages Open-Source PHP Projects
3+
4+
Thank you for considering contributing to our open-source projects! We strive to maintain a collaborative and welcoming environment for all contributors. Before submitting your contribution, please take a moment to review the following guidelines.
5+
6+
## Contribution Guidelines
7+
8+
1. **Mutual Respect**: Treat all community members with respect. We do not tolerate harassment or offensive behavior.
9+
10+
2. **Adherence to PSR Standards**: Our PHP projects follow the standards defined by [PHP-FIG](https://www.php-fig.org/). Please ensure that your code complies with the relevant PSR standards.
11+
12+
3. **Adherence to Lion-Packages Standards**: Our PHP projects also follow our own standards along with the PSR, lease [Lion-Packages Standards](https://lion-packages.vercel.app/standards).
13+
14+
3. **Creating an Issue**: Before starting work on a new feature or bug fix, please open an issue to discuss it. This helps ensure that your contribution aligns with the project's goals and avoids duplication of effort.
15+
16+
4. **Branching Strategy**: When contributing code, create a new branch off the `main` branch. Use a descriptive name for your branch that summarizes the changes you are making.
17+
18+
5. **Pull Request Process**: When submitting a pull request, provide a clear and concise description of the changes you've made. Ensure that your code passes all tests and linting checks. If your pull request addresses an open issue, reference the issue number in the description.
19+
20+
6. **Code Reviews**: All pull requests require review before merging. Be open to feedback and be willing to make changes based on reviewer suggestions.
21+
22+
7. **Documentation**: If your contribution introduces new features or changes existing functionality, update the project's documentation accordingly.
23+
24+
8. **Licensing**: By contributing to our projects, you agree to license your code under the same license as the project (typically [MIT License](https://opensource.org/licenses/MIT)). Ensure that any new files include the appropriate license header.
25+
26+
## Getting Started
27+
28+
To contribute to our projects, follow these steps:
29+
30+
1. Fork the repository to your GitHub account.
31+
2. Clone the forked repository to your local machine.
32+
3. Create a new branch for your contribution.
33+
4. Make your changes and commit them with descriptive commit messages.
34+
5. Push your changes to your forked repository.
35+
6. Open a pull request from your branch to the `main` branch of the original repository.
36+
37+
Thank you for contributing to Lion-Packages open-source projects! Your contributions help make our projects better for everyone.
38+
39+
If you have any questions or need further assistance, feel free to reach out to us or refer to our [Code of Conduct](CODE_OF_CONDUCT.md).
40+
41+
---

‎phpunit.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@
3636

3737
<exclude>
3838
<file>src/LionBundle/Helpers/Bundle/constants.php</file>
39+
<directory>src/LionBundle/Commands/Npm</directory>
3940
</exclude>
4041
</source>
4142

0 commit comments

Comments
 (0)