Skip to content
This repository was archived by the owner on Oct 14, 2020. It is now read-only.

Commit c0e5c89

Browse files
nigthknightnigthknight
authored
Merge pull request #61 from secureCodeBox/contributing
Add Contributing Guidelines and Code of Conduct to enable community driven development
2 parents 5464c2f + 92862f6 commit c0e5c89

File tree

2 files changed

+200
-0
lines changed

2 files changed

+200
-0
lines changed

‎CODE_OF_CONDUCT.md‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
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, religion, or sexual identity
11+
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
27+
overall community
28+
29+
Examples of unacceptable behavior include:
30+
31+
* The use of sexualized language or imagery, and sexual attention or
32+
advances of 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
36+
address, 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+
<secureCodeBox@iteratec.com>
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
87+
of 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
94+
permanent 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
114+
the community.
115+
116+
## Attribution
117+
118+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119+
version 2.0, available at
120+
<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
121+
122+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
123+
enforcement ladder](https://github.com/mozilla/diversity).
124+
125+
[homepage]: <https://www.contributor-covenant.org>
126+
127+
For answers to common questions about this code of conduct, see the FAQ at
128+
<https://www.contributor-covenant.org/faq>. Translations are available at
129+
<https://www.contributor-covenant.org/translations>.
130+

‎CONTRIBUTING.md‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Contributing
2+
3+
- [Contributing](#contributing)
4+
- [GitHub Flow](#github-flow)
5+
- [How to work with GitHub Flow](#how-to-work-with-github-flow)
6+
- [Working with Forks and Pull Requests](#working-with-forks-and-pull-requests)
7+
- [Working with Issues / How to Contribute in Issues](#working-with-issues--how-to-contribute-in-issues)
8+
- [How to Write Commit Messages](#how-to-write-commit-messages)
9+
- [Code of Conduct](#code-of-conduct)
10+
11+
## GitHub Flow
12+
13+
For more information see [GitHub Flow](https://githubflow.github.io/)
14+
15+
GitHub Flow is very lightweight (especially compared to GitFlow).
16+
This workflow uses only two kinds of branches:
17+
18+
- Feature branch
19+
- Main branch (previously called master)
20+
21+
The _feature_ branches are used to develop new features as well as fixes.
22+
These branches are usually created out of main.
23+
24+
Anything in the _main_ branch is deployable.
25+
The _main_ branch is expected to be deployed regularly and is considered stable.
26+
27+
### How to work with GitHub Flow
28+
29+
For more information see [GitHub Flow](https://githubflow.github.io/)
30+
31+
TL;DR
32+
33+
1. anything in the _main_ branch is deployable
34+
2. create descriptive branches off of main
35+
3. push to named branches constantly
36+
4. open a pull request at any time
37+
5. merge only after pull request review
38+
6. deploy immediately after review
39+
40+
## Working with Forks and Pull Requests
41+
42+
Our current continuous integration workflow makes it very hard to work on own forks of the _secureCodeBox_ because CI tests cannot be executed outside of our repository. We are aware of that problem and are working on a solution.
43+
44+
Generally the _secureCodeBox_ project follows the standard [GitHub Pull request process](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests).
45+
46+
## Working with Issues/How to Contribute in Issues
47+
48+
It is mandatory to open an issue, if the task takes longer than one hour.
49+
Before you open an issue please verify there is no existing one covering your issue.
50+
51+
## How to Write Commit Messages
52+
53+
For more information see [here](https://chris.beams.io/posts/git-commit/).
54+
55+
TL;DR
56+
57+
1. Separate subject from body with a blank line
58+
2. Limit the subject line to 50 characters
59+
3. Capitalize the subject line
60+
4. Do not end the subject line with a period
61+
5. Use the imperative mood in the subject line
62+
6. Wrap the body at 72 characters
63+
7. Use the body to explain what and why vs. how
64+
65+
NOTE: Make sure you don't include `@mentions` or `fixes` keywords in your git commit messages. These should be included in the PR body instead.
66+
67+
## Code of Conduct
68+
69+
Please have a look at our [Code of Conduct](./CODE_OF_CONDUCT.md) before you write an Issue or make a PR.
70+

0 commit comments

Comments
 (0)