Skip to content

Commit 1a730c0

Browse files
author
Andreas Frömer
committed
Adjust readme and other mds
1 parent b7190a4 commit 1a730c0

File tree

3 files changed

+123
-0
lines changed

3 files changed

+123
-0
lines changed

CODE_OF_CONDUCT.md

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

CONTRIBUTING.md

Whitespace-only changes.

README.md

+77
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,79 @@
11
# composer-unused
22
Show unused packages by scanning your code
3+
4+
## Motivation
5+
6+
Working in a big repository with multiple people, sometimes you might lose track
7+
of you required composer packages. You have so many packages you can't be sure if they are used
8+
or not.
9+
10+
You can use `composer why package/A` but that only gives you information about why this package is installed
11+
in dependency to another package.
12+
13+
What if you need to find out if the provided *namespaces* of the package are used in your code?
14+
15+
`composer unused` to the rescue!
16+
17+
![usage](https://media.giphy.com/media/LYrx0fhQ4qD8asscts/giphy.gif)
18+
19+
## Installation
20+
21+
Run
22+
23+
```bash
24+
$ composer global require icanhazstring/composer-unused
25+
```
26+
27+
## Usage
28+
29+
Run
30+
31+
```bash
32+
$ composer unused
33+
```
34+
35+
## Example (doctrine/orm)
36+
37+
```html
38+
vagrant@ubuntu-bionic:/vagrant/doctrine/orm$ composer unused
39+
40+
Loading packages
41+
----------------
42+
43+
Loading 15 requirements
44+
15/15 [-----------------------------] 100%
45+
46+
<span style="color: yellow">! [NOTE] Skipped 2 requirements. No package found or invalid constraint.</span>
47+
48+
* php
49+
* ext-ctype
50+
51+
! [NOTE] Found 13 packages to be checked.
52+
53+
Scanning files...
54+
-----------------
55+
56+
1174/1174 [-----------------------------] 100%
57+
58+
Found 13 usued and 0 unused packages
59+
60+
Results
61+
-------
62+
63+
Used packages
64+
* doctrine/annotations ✓
65+
* doctrine/cache ✓
66+
* doctrine/collections ✓
67+
* doctrine/dbal ✓
68+
* doctrine/event-manager ✓
69+
* doctrine/inflector ✓
70+
* doctrine/instantiator ✓
71+
* doctrine/persistence ✓
72+
* doctrine/reflection ✓
73+
* ocramius/package-versions ✓
74+
* ocramius/proxy-manager ✓
75+
* symfony/console ✓
76+
* symfony/var-dumper ✓
77+
78+
Unused packages
79+
```

0 commit comments

Comments
 (0)