Skip to content

Commit dec0434

Browse files
Merge pull request #8 from GlobalTechTalks/development
Merge dev into master
2 parents 7d066bd + 25ba3f7 commit dec0434

File tree

1 file changed

+100
-0
lines changed

1 file changed

+100
-0
lines changed

CONTRIBUTING.md

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# Contributing
2+
3+
When contributing to this repository, please first discuss the change you wish to make via issue,
4+
email, or any other method with the owners of this repository before making a change.
5+
6+
Please note we have a code of conduct, please follow it in all your interactions with the project.
7+
8+
## Developing Project
9+
You consider contributing to this project – thank you! Please consider these guidelines when creating a commit:
10+
11+
1. The commit message should flow the convention - we use commitzen to handle this, ensure it's installed before you proceed.
12+
2. Appropiate terminology should be choosen for the representing the commit ( feat, fix, refactor, chore etc.)
13+
3. The commit message should be brief & verbose.
14+
4. Features and bug fixes should be covered by test cases ( No PR will be merged without them ! )
15+
16+
## Pull Request Process
17+
18+
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
19+
build.
20+
2. Update the README.md with details of changes to the interface, this includes new environment
21+
variables, exposed ports, useful file locations and container parameters.
22+
3. Increase the version numbers in any examples files and the README.md to the new version that this
23+
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
24+
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
25+
do not have permission to do that, you may request the second reviewer to merge it for you.
26+
27+
## Code of Conduct
28+
29+
### Our Pledge
30+
31+
In the interest of fostering an open and welcoming environment, we as
32+
contributors and maintainers pledge to making participation in our project and
33+
our community a harassment-free experience for everyone, regardless of age, body
34+
size, disability, ethnicity, gender identity and expression, level of experience,
35+
nationality, personal appearance, race, religion, or sexual identity and
36+
orientation.
37+
38+
### Our Standards
39+
40+
Examples of behavior that contributes to creating a positive environment
41+
include:
42+
43+
* Using welcoming and inclusive language
44+
* Being respectful of differing viewpoints and experiences
45+
* Gracefully accepting constructive criticism
46+
* Focusing on what is best for the community
47+
* Showing empathy towards other community members
48+
49+
Examples of unacceptable behavior by participants include:
50+
51+
* The use of sexualized language or imagery and unwelcome sexual attention or
52+
advances
53+
* Trolling, insulting/derogatory comments, and personal or political attacks
54+
* Public or private harassment
55+
* Publishing others' private information, such as a physical or electronic
56+
address, without explicit permission
57+
* Other conduct which could reasonably be considered inappropriate in a
58+
professional setting
59+
60+
### Our Responsibilities
61+
62+
Project maintainers are responsible for clarifying the standards of acceptable
63+
behavior and are expected to take appropriate and fair corrective action in
64+
response to any instances of unacceptable behavior.
65+
66+
Project maintainers have the right and responsibility to remove, edit, or
67+
reject comments, commits, code, wiki edits, issues, and other contributions
68+
that are not aligned to this Code of Conduct, or to ban temporarily or
69+
permanently any contributor for other behaviors that they deem inappropriate,
70+
threatening, offensive, or harmful.
71+
72+
### Scope
73+
74+
This Code of Conduct applies both within project spaces and in public spaces
75+
when an individual is representing the project or its community. Examples of
76+
representing a project or community include using an official project e-mail
77+
address, posting via an official social media account, or acting as an appointed
78+
representative at an online or offline event. Representation of a project may be
79+
further defined and clarified by project maintainers.
80+
81+
### Enforcement
82+
83+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
84+
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
85+
complaints will be reviewed and investigated and will result in a response that
86+
is deemed necessary and appropriate to the circumstances. The project team is
87+
obligated to maintain confidentiality with regard to the reporter of an incident.
88+
Further details of specific enforcement policies may be posted separately.
89+
90+
Project maintainers who do not follow or enforce the Code of Conduct in good
91+
faith may face temporary or permanent repercussions as determined by other
92+
members of the project's leadership.
93+
94+
### Attribution
95+
96+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
97+
available at [http://contributor-covenant.org/version/1/4][version]
98+
99+
[homepage]: http://contributor-covenant.org
100+
[version]: http://contributor-covenant.org/version/1/4/

0 commit comments

Comments
 (0)