Skip to content

Commit 677052f

Browse files
committed
Add a code of conduct, update the gitignore file and simplify the README.
1 parent c593e58 commit 677052f

3 files changed

Lines changed: 71 additions & 3 deletions

File tree

.gitignore

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,17 @@ app/[Cc]onfig/core.php
66
app/[Cc]onfig/database.php
77
!empty
88
/vendor/*
9+
10+
# OS
11+
.DS_Store
12+
.AppleDouble
13+
.LSOverride
14+
Icon?
15+
._*
16+
.Spotlight-V100
17+
.Trashes
18+
.AppleDB
19+
.AppleDesktop
20+
Network Trash Folder
21+
Temporary Items
22+
.apdisk

CODE_OF_CONDUCT.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Contributor Code of Conduct
2+
3+
As contributors and maintainers of this project, and in the interest of
4+
fostering an open and welcoming community, we pledge to respect all people who
5+
contribute through reporting issues, posting feature requests, updating
6+
documentation, submitting pull requests or patches, and other activities.
7+
8+
We are committed to making participation in this project a harassment-free
9+
experience for everyone, regardless of level of experience, gender, gender
10+
identity and expression, sexual orientation, disability, personal appearance,
11+
body size, race, ethnicity, age, religion, or nationality.
12+
13+
Examples of unacceptable behavior by participants include:
14+
15+
* The use of sexualized language or imagery
16+
* Personal attacks
17+
* Trolling or insulting/derogatory comments
18+
* Public or private harassment
19+
* Publishing other's private information, such as physical or electronic
20+
addresses, without explicit permission
21+
* Other unethical or unprofessional conduct
22+
23+
Project maintainers have the right and responsibility to remove, edit, or
24+
reject comments, commits, code, wiki edits, issues, and other contributions
25+
that are not aligned to this Code of Conduct, or to ban temporarily or
26+
permanently any contributor for other behaviors that they deem inappropriate,
27+
threatening, offensive, or harmful.
28+
29+
By adopting this Code of Conduct, project maintainers commit themselves to
30+
fairly and consistently applying these principles to every aspect of managing
31+
this project. Project maintainers who do not follow or enforce the Code of
32+
Conduct may be permanently removed from the project team.
33+
34+
This Code of Conduct applies both within project spaces and in public spaces
35+
when an individual is representing the project or its community.
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
38+
reported by contacting a project maintainer at conduct@loadsys.com. All
39+
complaints will be reviewed and investigated and will result in a response that
40+
is deemed necessary and appropriate to the circumstances. Maintainers are
41+
obligated to maintain confidentiality with regard to the reporter of an
42+
incident.
43+
44+
45+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
46+
version 1.3.0, available at
47+
[http://contributor-covenant.org/version/1/3/0/][version]
48+
49+
[homepage]: http://contributor-covenant.org
50+
[version]: http://contributor-covenant.org/version/1/3/0/

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ To use this plugin, call it from the command line:
5050

5151
```shell
5252
$ cd path/to/app/
53-
$ ./bin/cake ConfigRead.ConfigRead Key.Name
53+
$ ./bin/cake config_read Key.Name
5454
'foo'
5555
```
5656

@@ -67,7 +67,7 @@ SECOND_KEY_THIRD='42'
6767
Note that this format is automatically used whenever more than one key is returned (unless the `--serialize` switch has been used). For example, if you request a key that contains an array, all values in the array will be returned sequentially. Alternatively, if you pass multiple keys on the command line, they will all be returned. The format can also be forced using the `-b` or `--bash` command line switch:
6868

6969
```shell
70-
$ ./bin/cake ConfigRead.ConfigRead -b Key.Name
70+
$ ./bin/cake config_read -b Key.Name
7171
KEY_NAME='foo'
7272
```
7373

@@ -80,7 +80,7 @@ Requesting multiple keys on the command line will produce an array of those keys
8080
This switch always overrides both the `--bash` switch and the Shell's automatic bash formatting.
8181

8282
```shell
83-
$ ./bin/cake ConfigRead.ConfigRead -s Key.Name Second.Key
83+
$ ./bin/cake config_read -s Key.Name Second.Key
8484
a:2:{s:8:"Key.Name";s:3:"foo";s:10:"Second.Key";a:3:{s:5:"First";s:3:"bar";s:6:"Second";s:3:"baz";s:5:"Third";i:42;}}
8585
# Check the result by piping into PHP and unserializing the result.
8686
$ ./bin/cake ConfigRead.ConfigRead -s Key.Name Second.Key | php -r 'print_r(unserialize(file_get_contents("php://stdin")));'
@@ -124,6 +124,10 @@ The "gotcha" here is that ConfigReadShell has to maintain a hard-coded list of C
124124

125125
## Contributing
126126

127+
### Code of Conduct
128+
129+
This project has adopted the Contributor Covenant as its [code of conduct](CODE_OF_CONDUCT.md). All contributors are expected to adhere to this code. [Translations are available](http://contributor-covenant.org/).
130+
127131
### Reporting Issues
128132

129133
Please use [GitHub Isuses](https://github.com/loadsys/CakePHP-ConfigReadShell/issues) for listing any known defects or issues.

0 commit comments

Comments
 (0)