Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Onboarding new persons #87

Open
wants to merge 23 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 99 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
# Code of Conduct

## Introduction
We expect this code of conduct to be honored by everyone who participates in sharing creates value formally or informally in any role.

This code is not exhaustive or complete. It serves to distill our common understanding of a collaborative, shared environment and goals. We expect it to be followed in spirit as much as in the letter, so that it can enrich all of us and the technical communities in which we participate.

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to make participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

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

## Our Responsibilities

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.

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.

## Scope

This Code of Conduct applies within all project spaces, and it also applies when
an individual is representing the project or its community in public spaces.
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.

## Conflict Resolution

Conflicts in an open source project can take many forms, from someone having a bad day and using harsh and hurtful language in the issue queue, to more serious instances such as sexist/racist statements or threats of violence, and everything in between.

If the behavior is threatening or harassing, or for other reasons requires immediate escalation, please see below.

However, for the vast majority of issues, we aim to empower individuals to first resolve conflicts themselves, asking for help when needed, and only after that fails to escalate further. This approach gives people more control over the outcome of their dispute.

If you are experiencing or witnessing conflict, we ask you to use the following escalation strategy to address the conflict:

1. Address the perceived conflict directly with those involved, preferably in a
real-time medium.
2. If this fails, get a third party (e.g. a mutual friend, and/or someone with
background on the issue, but not involved in the conflict) to intercede.
3. If you are still unable to resolve the conflict, and you believe it rises to
harassment or another code of conduct violation, report it.

## Reporting Violations

Violations of the Code of Conduct can be reported to the owner of this repository ([email protected]). All complaints will be reviewed, investigated and will be determined whether the Code of Conduct was violated. In case the Code of Conduct was violated we will issue an appropriate sanction, possibly including a written warning or expulsion from the project, project sponsored spaces. We ask that you make a good-faith effort to resolve your conflict via the conflict resolution policy before submitting a report.

Violations of the Code of Conduct can occur in any setting, even those unrelated to the project. We will only consider complaints have occurred within one year of the report.


## Enforcement

If the owner of this repository receives a report alleging a violation of the Code of Conduct, he will notify the accused of the report, and provide them an opportunity to discuss the report before a sanction is issued. The owner of this repository will do his utmost to keep the reporter anonymous. If the act is ongoing (such as someone engaging in harassment), or involves a threat to anyone's safety (e.g. threats of violence), the owner of the repository may issue sanctions without notice.

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.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq

It is also inspired by the following code of conducts
* [Apache foundation code of conduct](https://www.apache.org/foundation/policies/conduct)
* [TensorFlow code of conduct](https://github.com/tensorflow/tensorflow/blob/master/CODE_OF_CONDUCT.md)
39 changes: 39 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## Introduction

We welcome contributions via
[pull requests](https://help.github.com/articles/about-pull-requests/) filed against
[our repository](https://github.com/Open-Source-Compliance/Sharing-creates-value). A contribution can be code, bugfixes, documentation, presentation or any other content.

In order to be clear - we will not accept any pull request which deals with proprietary tools. In case you are not sure what this means please check the README file in the root directory of this project.

## Signing each commit

We do not require a CLA to be signed by you, we follow the more lightweight DCO (Developer Certificate of Origin) approach. A DCO is a way for a contributor to confirm that he/she wrote or otherwise has the right to submit code or documentation to a project. Simply add `Signed-off-by` as shown in the example below to indicate that you agree with the DCO. Only signed off PRs will be accepted

You can find the text of the [DCO here](https://developercertificate.org/ )

An example signed commit message:

```
Data Structures: Add attributes to class xyz
Signed-off-by: Cary Carlson <[email protected]>
```

## Rules you should care about

We have defined only very few rules how your commits shall look like and how they shall be phrased:

* Make separate commits for logically separate changes
* Provide meaningful commit messages
* Describe your changes well and in imperative
* To resolve conflicts, rebase pull request branches onto their target branch
* please make sure that your contributions are [REUSE](https://reuse.software/) conformant

For reuse conformance please provide the following information in every new file you intend to contribute:
```
# SPDX-FileCopyrightText: 2020 name of Copright owner
# SPDX-License-Identifier: License you have chosen
```
In case you contribute binaries, like pictures etc., check for the reuse best practice for binaries.

If you want to learn more the git project provides very good documentation about [how to submit patches](https://github.com/git/git/blob/master/Documentation/SubmittingPatches)
104 changes: 104 additions & 0 deletions Charter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@

## Overview

Sharing creates value is an open source community project. Anyone with an interest in the project is welcome join the community, contribute to the project, and participate in the decision making process. This document describes how participation takes place.
Please also check our:
* [Code of conduct](./CODE_OF_CONDUCT.md)
* [Contribution policy](./CONTRIBUTING.md)

## Structure
The most important thing about engaging with sharing creates value is that everyone is equal. We welcome everybody to join the community of this project and to contribute to the project. Anyone can use the artifacts developed in this project in accordance to the licenses which are valid to the particular artifact.

## Contributions
Contributions are the essential element of an open source project. No open source project will be successfull without contributions. Since contributions are fundamental we welcome contributions from all. We are happy to receive contributions to
* documentation (epics, user stories, glossary,
* data model (classes, attributes, associations, etc.)
* process flows
* case studies
* integration scenarios
* code and test cases
* website content

There is only one thing you shall be aware of the overall purpose of this project is to build an OSS compliance toolchain with open source tools. This means that we will not accept contributions, which might put a non open source tool into the toolchain or similar


## Decisions
Decisions about the future of the project are made with the community through discussion with all members ho wish to participate in the discussion, from the newest developers to the most experienced one. All project management discussion takes place in meetings and on the [email protected] mailing list. The meeting invitations are send to the mailing list.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo: "all members (w)ho wish"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you


### How Decisions are taken

Our objective is to take consensus based decisions. We follow the model of [Lazy Consensus](https://community.apache.org/committers/lazyConsensus.html) as defined by the [Apache Software Foundation](https://community.apache.org/)

In cases where no consensus can be achieved and a decision is required we do explicit votings.

#### Consensus Building
Sometimes there is no obvious path to take. In these cases we need to build consensus by making proposals and eliciting responses.

We want to avoid unnecessary discussion and the creation of significant amounts of unnecessary mail that everyone in the community needs to read. That is not to say that we want to avoid constructive discussion. This is the lifeblood of a successful project.

##### Expressing support (or otherwise)
First of all, it is important to understand that everyone is invited to express their opinion of any given action or proposal. As already stated sharing creates value is a community project in which no single individual has more power than any other single individual (except in a very few procedural situations).

The notation used is "+1", "-1" and "0".

So, what do these notations mean?

* +1 means "I agree with this and will help make it happen"
* 0 I have no strong opinion
* -1 means "I don't agree and I am offering an alternative that I am able to help implement"

The important thing is that this is not an exact science. It's just a shorthand way of communicating strength of feeling.

##### Consensus Building is Not Voting
The confusing thing about this notation is that it is the same notation used in a formal vote. Knowing when something is a vote and when it is a preference is important. It's easy to tell though, if the subject does not have "[Vote]" at the start then it's just an opinion. We try not to call votes, consensus building is much more inclusive.

The reasons for this notation being common is that when someone wants to summarise a discussion thread they can mentally add up the strength of feeling of the community and decide if there is consensus or not.

Once there is a clear consensus members of the community can proceed with the work under the [lazy consensus model](https://community.apache.org/committers/lazyConsensus.html).

#### Votings
##### Preparing for a Vote

Before calling a vote it is important to ensure that the community is given time to discuss the upcoming vote. This will be done by posting an email to the list indicating the intention to call a vote and the options available. By the time a vote is called there should already be consensus in the community. The vote itself is, normally, a formality.

##### Calling a Vote
Once it is time to call the vote a mail is posted with a subject starting with [VOTE]. This enables the community members to ensure they do not miss an important vote thread. It also indicates that this is not consensus building but a formal vote.
When calling a vote you need to describe the issue with no ambiguity and in a positive sense. Define the date and time for the end of the vote period.

Votes are expressed by replying email using the voting symbols defined above. Voters can change their vote during the timeframe. At the end of the vote period, the instigator tallies the number of final votes and reports the results.

##### Casting Your Vote
The notation used in voting is:

* +1 Yes I agree
* 0 I have no strong opinion
* -1 I object on the following grounds

If you object you must support your objection and provide an alternative course of action that you are willing and able to implement (where appropriate).


## License policy
We follow a simple and clear approach in regard to licensing. All artifacts which are documentation are per default licensed under CC-BY-SA-4.0, we also accept contributions under CC0-1.0

All artifacts which are code (including tests) are licensed under MIT or under its original license (for already existing code that shall be contributed).

## Logo usage
You can use our logo unchanged when the following conditions apply:
* You do a presentation about Open Source compliance tools which are licensed under an Open Source compliant license. Please note if the presentation is about a mixture of OSS tools and commercial tools the usage of our logo is prohibited
* You do a presentation or a workshop or something similar to introduce, promote this project
* You want to promote a certain tool which is licensed under an Open Source compliant license. Please note that in case there is a commercial tool which provides an "Open Source" connectors or APIs (aka open core model inversed) the usage of our logo is prohibited.
* You want to promote (paid) services you offer in the context of this effort. Like you offer development and consulting services to integrate tools licensed under an Open Source compliant license in a specific IT infrastructure.

Using our logo under other conditions is per se not allowed. In case you have doubts whether you can use our logo please write to our [mailing list](mailto:[email protected]) explaining the context where you want to use our logo.
Changing our logo in a way that it can be mixed with our original is not allowed. The following list shall serve as an example and does not aim for completeness:

* Do not alter or manipulate our logo in any way.
* Do not attempt to use a different typeface or color.
* Do not add any decorations to our logo.
* Do not remove anything from our logo
* Do not skew the logo at an angle, stretch or compress our logo.


## Attribution

Parts of the Charter, especially the decision making parts, are inspired by the [Apache Software Foundation](https://community.apache.org/)
5 changes: 3 additions & 2 deletions FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,11 @@ Everybody is invited to contribute any material, which will make an OSS complian

## How to contribute?
Like any other state of the art OSS project, we need a prove that all information / code / documents /or any other contributions are contributed with the right and allowance to do so.
So please make sure that you have the right or allowance to contribute the material you want to contribute to this project under the license which is valid to the particular contribution.
So please make sure that you have the right or allowance to contribute the material you want to contribute to this project under the license which is valid to the particular contribution.
Please take a look at our [contribution guideline](./CONTRIBUTING.md).

## What is the the license of the project?
Different parts of the project fall under different licenses. To the conceptual materialincluding the big picture, the documentation, the user stories, the sequence charts CC-BY-SA-4.0 apply. Sourece code and test cases will be licensed under a license which does not conflict with the licenses of the integrated tools.
Different parts of the project fall under different licenses. To the conceptual material including the big picture, the documentation, the user stories, the sequence charts CC-BY-SA-4.0 applies. Source code and test cases will be licensed under a license which does not conflict with the licenses of the integrated tools.



Loading