Skip to content

Commit 82866e8

Browse files
author
John
committed
#109 Added CODE_OF_CONDUCT.md and updated the documentation for contributing.
1 parent 6efedba commit 82866e8

13 files changed

+344
-295
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,3 +126,4 @@ v1.0.0-beta1 (in progress)
126126
- Updated .gitlab-ci so that tests run on all merge requests and deploy to
127127
wiki/phpdoc on merges.
128128
- Updated notes for contributing
129+
- Moved code of conduct into CODE_OF_CONDUCT.md.

CODE_OF_CONDUCT.md

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

CONTRIBUTING.md

Lines changed: 0 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -17,83 +17,6 @@ Process
1717
For more detailed notes of the contributing process, please
1818
visit [Contributing][contributing]
1919

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

9922
[gitlab]: https://gitlab.com/john89/api_open_studio

includes/wiki/developers/bookdown.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,17 @@
77
}
88
},
99
"content": [
10+
"contributing/bookdown.json",
1011
"coding-standards.md",
11-
"configuring-debug-levels.md",
12-
"contributing.md",
1312
"linting.md",
13+
"testing.md",
14+
"xdebug.md",
15+
"configuring-debug-levels.md",
1416
"processors.md",
1517
"creating-processors.md",
1618
"error-responses.md",
1719
"resources.md",
18-
"testing.md",
19-
"sys-admin/bookdown.json",
20-
"xdebug.md"
20+
"sys-admin/bookdown.json"
2121
],
2222
"tocDepth": 1
2323
}

0 commit comments

Comments
 (0)