Skip to content

Commit 860e3cd

Browse files
jmesniljmesnil
committed
[STXM-22] Improve community standards
* Add README (with sections to report issues and release procedure) * Add Security policy to report security issues * Add Code of Conduct JIRA: https://issues.redhat.com/browse/STXM-22 Signed-off-by: Jeff Mesnil <[email protected]>
1 parent db598e9 commit 860e3cd

File tree

3 files changed

+194
-0
lines changed

3 files changed

+194
-0
lines changed

‎CODE_OF_CONDUCT.md

+133
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
2+
# Contributor Covenant 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 e-mail 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+
[email protected].
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

‎README.MD

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# StAXMapper
2+
3+
StAXMapper is a thin StAX facade which supports plugability plus some usability enhancements.
4+
5+
StAXMapper is released as a single Maven artifact with the coordinates:
6+
7+
```
8+
<dependency>
9+
<groupId>org.jboss</groupId>
10+
<artifactId>staxmapper</artifactId>
11+
</dependency>
12+
```
13+
14+
# Build StAXMapper
15+
16+
Prerequisites:
17+
18+
* JDK 11 or newer - check `java -version`
19+
* Maven 3.6.0 or newer - check `mvn -v`
20+
21+
To build with your own Maven installation:
22+
23+
```
24+
mvn package
25+
```
26+
27+
# Reporting Issues
28+
29+
StAXMapper uses JIRA to manage issues. All issues can be found [here](https://issues.redhat.com/projects/STXM/issues).
30+
31+
To create a new issue, comment on an existing issue, or assign an issue to yourself, you'll need to first [create a JIRA account](https://issues.redhat.com/).
32+
33+
# Release Procedure
34+
35+
StAXMapper is released in [JBoss Nexus Repository](https://repository.jboss.org/nexus/)
36+
37+
To release a new version of StAXMapper:
38+
39+
* Use the Maven [`release` plugin](https://maven.apache.org/maven-release/maven-release-plugin/):
40+
41+
```
42+
mvn release:prepare
43+
mvn release:perform
44+
```
45+
46+
* Close and publish the staged artifacts from [JBoss Nexus Repository](https://repository.jboss.org/nexus/)
47+
* Release the published version in [JIRA](https://issues.redhat.com/projects/STXM?selectedItem=com.atlassian.jira.jira-projects-plugin:release-page&status=released-unreleased)
48+
* Update the Release Notes in [GitHub Release page](https://github.com/jbossas/staxmapper/releases)
49+
50+

‎SECURITY.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Security Policy
2+
3+
## Security Contacts and Procedures
4+
5+
Red Hat takes security very seriously, and we aim to take immediate action to address serious security-related problems that involve our products or services.
6+
7+
Please report any suspected security vulnerability in this project to Red Hat Product Security at [email protected]. You can use our GPG key to communicate with us securely.
8+
9+
To report an issue in any Red Hat branded website or online service, please contact Red Hat Information Security at [email protected].
10+
11+
https://access.redhat.com/security/team/contact

0 commit comments

Comments
 (0)