Skip to content

Commit

Permalink
[JBWS-4346]:Add community guideline files
Browse files Browse the repository at this point in the history
  • Loading branch information
jimma committed Feb 13, 2023
1 parent 2bf235e commit 7b10cf3
Show file tree
Hide file tree
Showing 3 changed files with 193 additions and 0 deletions.
132 changes: 132 additions & 0 deletions CODE_OF_CONDUCT.md
@@ -0,0 +1,132 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders 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, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement:
at Jim Ma <ema@redhat.com> or Rebecca Searls <rsearls@redhat.com>
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
50 changes: 50 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,50 @@
Contributing Guide
==================================

We welcome contributions from the community. This guide will walk you through the steps for getting started on our project.

- [Git Setup](#git-setup)
- [Issues](#issues)
- [Good First Issues](#good-first-issues)
- [Code Style](#code-style)



## Git Setup
To contribute, you first need to fork the [jbossws-parent](https://github.com/jbossws/jbossws-parent) repository.
then clone your newly forked copy onto your local workspace.
And make sure you have set up your Git authorship correctly:
```
git config --global user.name "Your Full Name"
git config --global user.email your.email@example.com
```
To pull update from the jbossws-parent upstream, the jbossws-parent remote can be added to your local git repo :
```
git remote add upstream https://github.com/jbossws/jbossws-parent.git
```
Before change/fix, always pull update from jbossws-parent:
```
$ git checkout -f main
$ git pull --rebase upstream main
```

## Issues
JBssWS project uses JIRA to manage issues. All issues can be found [here](https://issues.redhat.com/projects/JBWS/issues).

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/).


### Good First Issues

We added the project issues with `good-first-issue` label for good to start the contribution. These can be found [here](https://issues.redhat.com/issues/?filter=12406834).
When you start the issue you'd like to contribute, please make sure it isn't assigned to someone else. To assign the selected issue to yourself, click the "Assign" and check the
assignee name before finish.
It is highly recommended creating a topic git branch for one JIRA issue. A commit message with JIRA number is always a good
practice to track which commit resolve which JIRA issue. Later the commit or PR number will be automatically linked to JIRA system.
After finish the JIRA issue task, creating a GitHub pull request based on main branch. We'll monitor the PR queus and
get the PR reviewed and merged.
If you encounter any problem during the contribution, please use [GitHub discussion](https://github.com/jbossws/jbossws-cxf/discussions) to let us know.

## Code Style
If you are using Eclipse then set your code style to eclipse/jboss-style.xml and check style to eclipse/jboss-format.xml.
And please make sure you're putting correct license headers to Java and XML files.
11 changes: 11 additions & 0 deletions SECURITY.md
@@ -0,0 +1,11 @@
# Security Policy

## Security Contacts and Procedures

JBossWS community takes security very seriously, and we aim to take immediate action to address serious security-related problems that involve our products or services.

Please report any suspected security vulnerability in this project to Red Hat Product Security at secalert@redhat.com. You can use our GPG key to communicate with us securely.

To report an issue in any Red Hat branded website or online service, please contact Red Hat Information Security at site-security@redhat.com.

https://access.redhat.com/security/team/contact

0 comments on commit 7b10cf3

Please sign in to comment.