Skip to content

Commit 408ecfd

Browse files
committed
Add Code of Conduct and Contributing guidelines
1 parent 007c84c commit 408ecfd

File tree

3 files changed

+119
-0
lines changed

3 files changed

+119
-0
lines changed

CODE_OF_CONDUCT.md

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
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 may be
58+
reported by contacting one of the project maintainers listed below. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Project Maintainers
69+
70+
* Codeship Engineering Team
71+
72+
## Attribution
73+
74+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
75+
available at [http://contributor-covenant.org/version/1/4][version]
76+
77+
[homepage]: http://contributor-covenant.org
78+
[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Contributing
2+
3+
*Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.*
4+
5+
In the spirit of [free software][free-sw], **everyone** is encouraged to help improve this project. Here are some ways *you* can contribute:
6+
7+
* by reporting errors on our documentation pages
8+
* by suggesting new articles or enhancements to existing ones
9+
* by writing documentation (**no patch is too small** : fix typos, add comments, clean up inconsistent whitespace)
10+
* by closing [issues][issues]
11+
* by reviewing patches and pull requests
12+
13+
## Submitting an Issue
14+
We use the [GitHub issue tracker][issues] to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. When submitting a bug report, please include any details that may be necessary to reproduce the bug.
15+
16+
## Submitting a Pull Request
17+
1. [Fork the repository.][fork]
18+
2. [Create a topic branch.][branch]
19+
3. Implement your feature or bug fix.
20+
4. Add, commit, and push your changes.
21+
5. [Submit a pull request.][pr]
22+
23+
## When not to submit an issue
24+
25+
Please don't create new issues on this repository when you experience issues with your builds on https://codeship.com, want to request new features for the CI system or have general questions on how to use https://codeship.com for your projects.
26+
27+
In all of the above cases, reach out to our support team at [email protected] or on Twitter at [@CodeshipSupport](https://twitter.com/CodeshipSupport).
28+
29+
[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
30+
[issues]: https://github.com/codeship-library/aws/issues
31+
[gist]: https://gist.github.com/
32+
[fork]: http://help.github.com/fork-a-repo/
33+
[branch]: https://github.com/blog/1377-create-and-delete-branches
34+
[pr]: http://help.github.com/send-pull-requests/

README.md

+7
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,10 @@ This container allows you to generate a temporary dockercfg using your AWS crede
1010

1111
See the [dockercfg-generator ReadMe](dockercfg-generator/README.md) for more details and usage instructions.
1212

13+
## Contributing
14+
15+
We are happy to hear your feedback. Please read our [contributing guidelines](CONTRIBUTING.md) and the [code of conduct](CODE_OF_CONDUCT.md) before you submit a pull request or open a ticket.
16+
17+
## License
18+
19+
see [LICENSE](LICENSE)

0 commit comments

Comments
 (0)