Skip to content

Commit 3cd416b

Browse files
committed
updated docs
1 parent 968ee2f commit 3cd416b

File tree

3 files changed

+139
-5
lines changed

3 files changed

+139
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -73,11 +73,15 @@ No sponsors yet! **Will you be the first?**
7373

7474
## Contributing
7575

76-
* Fork it
77-
* Create your update branch (git checkout -b my-feature-branch)
78-
* Commit your changes (git commit -am 'Add some features')
79-
* Push to the branch (git push origin my-feature-branch)
80-
* Create new Pull Request
76+
Refer to **[CONTRIBUTING.md](docs/CONTRIBUTING.md)** to see how to contribute to Open Template Hub.
77+
78+
<br/>
79+
80+
## Code of Conduct
81+
82+
Refer to **[CODE_OF_CONDUCT.md](docs/CODE_OF_CONDUCT.md)** to see contributor covenant code of conduct.
83+
84+
<br/>
8185

8286
## LICENSE
8387

docs/CODE_OF_CONDUCT.md

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible 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.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to a positive environment for our community include:
12+
13+
* Demonstrating empathy and kindness toward other people
14+
* Being respectful of differing opinions, viewpoints, and experiences
15+
* Giving and gracefully accepting constructive feedback
16+
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17+
* Focusing on what is best not just for us as individuals, but for the overall community
18+
19+
Examples of unacceptable behavior include:
20+
21+
* The use of sexualized language or imagery, and sexual attention or advances of any kind
22+
* Trolling, insulting or derogatory comments, and personal or political attacks
23+
* Public or private harassment
24+
* Publishing others' private information, such as a physical or email address, without their explicit permission
25+
* Other conduct which could reasonably be considered inappropriate in a professional setting
26+
27+
## Enforcement Responsibilities
28+
29+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
32+
33+
## Scope
34+
35+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
36+
37+
## Enforcement
38+
39+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at info@opentemplatehub.com. All complaints will be reviewed and investigated promptly and fairly.
40+
41+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
42+
43+
## Enforcement Guidelines
44+
45+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
46+
47+
### 1. Correction
48+
49+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
50+
51+
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
52+
53+
### 2. Warning
54+
55+
**Community Impact**: A violation through a single incident or series of actions.
56+
57+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
58+
59+
### 3. Temporary Ban
60+
61+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
62+
63+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
64+
65+
### 4. Permanent Ban
66+
67+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
68+
69+
**Consequence**: A permanent ban from any sort of public interaction within the community.
70+
71+
## Attribution
72+
73+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at
74+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
75+
76+
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
77+
78+
[homepage]: https://www.contributor-covenant.org
79+
80+
For answers to common questions about this code of conduct, see the FAQ at
81+
https://www.contributor-covenant.org/faq. Translations are available at
82+
https://www.contributor-covenant.org/translations.
83+
84+
85+
86+
87+
88+
89+
<table align="right"><tr><td><a href="https://opentemplatehub.com"><img src="https://raw.githubusercontent.com/open-template-hub/open-template-hub.github.io/master/assets/logo/brand-logo.png" width="50px" alt="oth"/></a></td><td><b>Open Template Hub © 2021</b></td></tr></table>
90+

docs/CONTRIBUTING.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
## How to contribute to Open Template Hub
2+
3+
### Did you find a bug?
4+
5+
Ensure the bug was not already reported by searching on GitHub under Issues.
6+
7+
If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.
8+
9+
If possible, use the relevant bug report templates to create the issue. Simply copy the content of the appropriate template into issue, make the necessary changes to demonstrate the issue, and paste the content into the issue description.
10+
11+
### Did you write a patch that fixes a bug?
12+
13+
Open a new GitHub pull request with the patch.
14+
15+
Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
16+
17+
Before submitting, please read the Contributing to Open Template Hub guide to know more about coding conventions etc.
18+
19+
### Did you fix whitespace, format code, or make a purely cosmetic patch?
20+
21+
Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of Open Template Hub will generally not be accepted.
22+
23+
### Do you intend to add a new feature or change an existing one?
24+
25+
Suggest your change in the feature request issues and start writing code.
26+
27+
### Do you want to contribute to the Open Template Hub documentation?
28+
29+
Please read Contributing to the Open Template Hub Documentation.
30+
31+
This is a volunteer effort we know the value of your time. We encourage you to pitch in and join the team!
32+
33+
Thanks! 💚
34+
35+
Open Template Hub Team
36+
37+
38+
39+
40+
<table align="right"><tr><td><a href="https://opentemplatehub.com"><img src="https://raw.githubusercontent.com/open-template-hub/open-template-hub.github.io/master/assets/logo/brand-logo.png" width="50px" alt="oth"/></a></td><td><b>Open Template Hub © 2021</b></td></tr></table>

0 commit comments

Comments
 (0)