Skip to content

Commit 8d53a4f

Browse files
szuecsarjunrn
authored andcommitted
add some stuff to achieve silver badge (zalando#940)
add more to the contributing guide which is needed to reach silver cii badge Signed-off-by: Sandor Szücs <[email protected]>
1 parent c051665 commit 8d53a4f

File tree

3 files changed

+91
-3
lines changed

3 files changed

+91
-3
lines changed

CODE_OF_CONDUCT.md

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

CONTRIBUTING.md

+13-3
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ There are multiple ways of getting involved:
99
- [Contribute code](#contribute-code)
1010

1111
Below are a few guidelines we would like you to follow.
12-
If you need help, please reach out to us: [email protected]
12+
If you need help, please reach out to us: [community channels](https://github.com/zalando/skipper#community)
13+
1314

1415
## Report a bug
1516
Reporting bugs is one of the best ways to contribute. Before creating a bug report, please check that an [issue](https://github.com/zalando/skipper/issues) reporting the same problem does not already exist. If there is an such an issue, you may add your information as a comment.
@@ -19,18 +20,22 @@ To report a new bug you should open an issue that summarizes the bug and set the
1920
If you want to provide a fix along with your bug report: That is great! In this case please send us a pull request as described in section [Contribute Code](#contribute-code).
2021

2122
## Suggest a feature
22-
To request a new feature you should open an [issue](https://github.com/zalando/skipper/issues/new) and summarize the desired functionality and its use case. Set the issue label to "feature".
23+
To request a new feature you should open an [issue](https://github.com/zalando/skipper/issues/new) and summarize the desired functionality and its use case. Set the issue label to "enhancement".
2324

2425
## Contribute code
2526
This is a rough outline of what the workflow for code contributions looks like:
2627
- Check the list of open [issues](https://github.com/zalando/skipper/issues). Either assign an existing issue to yourself, or create a new one that you would like work on and discuss your ideas and use cases.
2728
- Fork the repository on GitHub
28-
- Create a topic branch from where you want to base your work. This is usually master.
29+
- Create a topic branch, for example feature/foo fix/bar refactor/baz, from where you want to base your work. The base is usually master.
2930
- Make commits of logical units.
3031
- Write good commit messages (see below).
3132
- Push your changes to a topic branch in your fork of the repository.
3233
- Submit a pull request to [zalando/skipper](https://github.com/zalando/skipper)
3334
- Your pull request must receive a :thumbsup: from two [Maintainers](https://github.com/zalando/skipper/blob/master/MAINTAINERS)
35+
- Major changes need to include tests. Features need
36+
additionally include documentation for developers as
37+
[godoc](https://godoc.org/github.com/zalando/skipper) and add
38+
[user documentation in markdown](https://opensource.zalando.com/skipper) in the docs/ directory.
3439

3540
Thanks for your contributions!
3641

@@ -43,3 +48,8 @@ Your commit messages ideally can answer two questions: what changed and why. The
4348
When creating a pull request, its comment should reference the corresponding issue id.
4449

4550
**Have fun and enjoy hacking!**
51+
52+
## Governance - final decisions
53+
54+
The project owner and lead makes all final decisions, if there is a
55+
disagreement between contributors and maintainers.

readme.md

+2
Original file line numberDiff line numberDiff line change
@@ -276,6 +276,8 @@ Blog posts:
276276
- [Building our own open source http routing
277277
solution](https://jobs.zalando.com/tech/blog/building-our-own-open-source-http-routing-solution/):
278278
Giving some context about why Skipper was created in the first place.
279+
- [Kubernetes in production @ ShopGun](https://itnext.io/kubernetes-in-production-shopgun-2c280f0c0923)
280+
- Hacker News [Skipper – An HTTP router and reverse proxy for service composition](https://news.ycombinator.com/item?id=18837936)
279281

280282
Conference/Meetups talks
281283

0 commit comments

Comments
 (0)