Skip to content

Commit 8c64401

Browse files
MulkaveMulkave
committed
Merge branch 'main' of github.com:lucid-architecture/lucid
2 parents bd54ce4 + 9785423 commit 8c64401

File tree

2 files changed

+229
-0
lines changed

2 files changed

+229
-0
lines changed

‎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.

‎CONTRIBUTING.md‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
## Bug & Issue Reports
2+
3+
To encourage active collaboration, Lucid strongly encourages contribution through [pull requests](#which-branch-and-how-to-contribute).
4+
"Bug reports" may be searched or created in [issues](https://github.com/lucidarch/lucid/issues) or sent in the form of a [pull request](#which-branch-and-how-to-contribute) containing a failing test or steps to reproduce the bug.
5+
6+
If you file a bug report, your issue should contain a title and a clear description of the issue. You should also include as much relevant information as possible and a code sample that demonstrates the issue. The goal of a bug report is to make it easy for yourself - and others - to replicate the bug and develop a fix.
7+
8+
⏱ PRs and issues are usually checked about three times a week so there is a high chance yours will be picked up soon.
9+
10+
The Lucid Architecture source code is on GitHub as [lucidarch/lucid](https://github.com/lucidarch/lucid).
11+
12+
## Support Questions
13+
14+
Lucid Architecture's GitHub issue trackers are not intended to provide help or support. Instead, use one of the following channels:
15+
16+
- [Discussions](https://github.com/lucidarch/lucid/discussions) is where most conversations takes place
17+
- For a chat hit us on our official [Slack workspace](https://lucid-slack.herokuapp.com/) in the `#support` channel
18+
- If you prefer StackOverflow to post your questions you may use [#lucidarch](https://stackoverflow.com/questions/tagged/lucidarch) to tag them
19+
20+
## Core Development Discussion
21+
22+
You may propose new features or improvements of existing Lucid Architecture behaviour in the [Lucid Discussins](https://github.com/lucidarch/lucid/discussions).
23+
If you propose a new feature, please be willing to implement at least some of the code that would be needed to complete the feature, or collaborate on active ideation in the meantime.
24+
25+
Informal discussion regarding bugs, new features, and implementation of existing features takes place in the `#internals` channel of the [Lucid Slack workspace](https://lucid-slack.herokuapp.com/).
26+
Abed Halawi, the maintainer of Lucid, is typically present in the channel on weekdays from 8am-5pm EEST (Eastern European Summer Time), and sporadically present in the channel at other times.
27+
28+
## Which Branch? And How To Contribute
29+
30+
The `main` branch is what contains the latest live version and is the one that gets released.
31+
32+
- Fork this repository
33+
- Clone the forked repository to where you'll edit your code
34+
- Create a branch for your edits (e.g. `feature/queueable-units`, `fix/issue-31`)
35+
- Commit your changes and their tests (if applicable) with meaningful short messages
36+
- Push your branch `git push origin feature/queueable-units`
37+
- Open a [PR](https://github.com/lucidarch/lucid/compare) to the `main` branch, which will run tests for your edits
38+
39+
⏱ PRs and issues are usually checked about three times a week.
40+
41+
42+
### Setup for Development
43+
44+
Following are the steps to setup for development on Lucid:
45+
46+
> Assuming we're in `~/dev` directory...
47+
48+
- Clone the forked repository `[your username]/lucid` which will create a `lucid` folder at `~/dev/lucid`
49+
- Create a Laravel project to test your implementation in it `composer create-project laravel/laravel myproject`
50+
- Connect the created Laravel project to the local Lucid installation; in the Laravel project's `composer.json`
51+
```json
52+
"require": {
53+
"...": "",
54+
"lucidarch/lucid": "@dev"
55+
},
56+
"repositories": [
57+
{
58+
"type": "path",
59+
"url": "~/dev/lucid",
60+
"options": {
61+
"symlink": true
62+
}
63+
}
64+
],
65+
"minimum-stability": "dev",
66+
```
67+
> Make sure you change the `url` to the absolute path of your directory
68+
69+
- Run `composer update` to create the symlink
70+
71+
Now all your changes in the lucid directory will take effect automatically in the project.
72+
73+
## Security Vulnerabilities
74+
75+
If you discover a security vulnerability within Lucid, please send an email to Abed Halawi at [[email protected]](mailto:[email protected]).
76+
All security vulnerabilities will be promptly addressed.
77+
78+
## Coding Style
79+
80+
Lucid Architecture follows the [PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) coding standard and the [PSR-4](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader.md) autoloading standard.
81+
82+
### PHPDoc
83+
84+
Below is an example of a valid Lucid Architecture documentation block. Note that the `@param` attribute is followed by two spaces, the argument type, two more spaces, and finally the variable name:
85+
86+
```php
87+
/**
88+
* Register a binding with the container.
89+
*
90+
* @param string|array $abstract
91+
* @param \Closure|string|null $concrete
92+
* @param bool $shared
93+
* @return void
94+
*
95+
* @throws \Exception
96+
*/
97+
public function bind($abstract, $concrete = null, $shared = false)
98+
{
99+
//
100+
}
101+
```

0 commit comments

Comments
 (0)