Skip to content

Commit 1adeae9

Browse files
cotes2020cotes2020
committed
Improved the community docs.
- Added the PR template & code of conduct - Improved the issue templates.
1 parent 5782585 commit 1adeae9

File tree

5 files changed

+163
-59
lines changed

5 files changed

+163
-59
lines changed

‎.github/CODE_OF_CONDUCT.md‎

Lines changed: 76 additions & 0 deletions
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, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and 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 the project team at cotes.chung@gmail.com. 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+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,36 +4,44 @@ about: Create a report to help us improve
44
labels: bug
55
---
66

7-
<!-- Please make sure you have read the README or Wiki, and your question does not appear in other existing issues (including closed ones). Thanks for your cooperation! Now let's start it. -->
7+
# Checklist
8+
<!-- Please complete the following list of tasks, and then check it by change the "[ ]" to "[x]" -->
9+
- [ ] I have read the [tutorials](https://chirpy.cotes.info/categories/tutorial/) and know the correct effect of the functional design.
10+
- [ ] There are no similar reports on existing issues (including closed ones).
11+
- [ ] I found the bug on the latest code of `master` branch.
812

9-
**Describe the bug**
13+
14+
# Describe the bug
1015
<!-- A clear and concise description of what the bug is. -->
1116

12-
**To Reproduce**
13-
<!--
17+
## To Reproduce
18+
1419
Steps to reproduce the behavior:
20+
1521
1. Go to '...'
1622
2. Click on '....'
1723
3. Scroll down to '....'
1824
4. See error
19-
-->
2025

21-
**Expected behavior**
26+
27+
## Expected behavior
2228
<!-- A clear and concise description of what you expected to happen. -->
2329

24-
**Screenshots**
30+
## Screenshots
2531
<!-- If applicable, add screenshots to help explain your problem. -->
2632

27-
**Desktop (please complete the following information):**
33+
## Desktop:
34+
<!-- Please complete the following information -->
2835
- OS: [e.g. iOS]
2936
- Browser: [e.g. chrome, safari]
3037
- Version: [e.g. 22]
3138

32-
**Smartphone (please complete the following information):**
39+
## Smartphone:
40+
<!-- please complete the following information -->
3341
- Device: [e.g. iPhone6]
3442
- OS: [e.g. iOS8.1]
3543
- Browser: [e.g. stock browser, safari]
3644
- Version: [e.g. 22]
3745

38-
**Additional context**
46+
## Additional context
3947
<!-- Add any other context about the problem here. -->

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,25 @@ about: Suggest an idea for this project
44
labels: enhancement
55
---
66

7-
<!-- Please make sure your request does not appear in other existing issues (including closed ones). Thanks for your cooperation. Now, I can't wait to listen your idea! -->
7+
# Checklist
8+
<!-- Please complete the following list of tasks, and then check it by change the "[ ]" to "[x]" -->
9+
- [ ] I have read the [contributing guidelines](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/.github/CONTRIBUTING.md).
10+
- [ ] There are no similar request on existing issues (including closed ones).
11+
- [ ] I have read the [project progress](https://github.com/cotes2020/jekyll-theme-chirpy/projects) and know the current progress of the project.
12+
- [ ] I was in the `master` branch of the latest code.
813

914

10-
**Is your feature request related to a problem? Please describe.**
15+
# Is your feature request related to a problem? Please describe
1116
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
1217

13-
**Describe the solution you'd like**
18+
19+
# Describe the solution you'd like
1420
<!-- A clear and concise description of what you want to happen. -->
1521

16-
**Describe alternatives you've considered**
22+
23+
# Describe alternatives you've considered
1724
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
1825

1926

20-
**Additional context**
27+
# Additional context
2128
<!-- Add any other context or screenshots about the feature request here. -->

‎.github/ISSUE_TEMPLATE/question.md‎

Lines changed: 11 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -4,54 +4,21 @@ about: Ask what ever you want
44
labels: question
55
---
66

7-
<!-- Please make sure you have read the README or Wiki, and your question does not appear in other existing issues (including closed ones). Thanks for your cooperation. Now, uncomment the relevant part to describe the situation. -->
7+
# Checklist
8+
<!-- Please complete the following list of tasks, and then check it by change the "[ ]" to "[x]" -->
9+
- [ ] I have read the [tutorials](https://chirpy.cotes.info/categories/tutorial/) and know the correct effect of the functional design.
10+
- [ ] There are no similar question on existing issues (including closed ones).
11+
- [ ] I searched the Internet for related problems, but still couldn't solve it.
12+
- [ ] My question is based on the latest code of `master` branch.
813

9-
<!--
10-
**Don't understand what the README or Wiki says.**
11-
Point out the parts that are hard for you to understand.
12-
-->
1314

15+
# I don't understand what the ReadMe/Wiki says
1416
<!--
15-
**Want to complain about my bad days.**
16-
Don't hesitate to share your story!
17-
-->
18-
19-
<!--
20-
**Just wanted to say hi to the author.**
21-
Hi, I'm ..., have a nice day !
17+
Point out the parts that are hard for you to understand.
2218
-->
2319

2420

21+
# I have other questions
2522
<!--
26-
**Not sure if it's a bug**
27-
Please try to describe the problem
28-
29-
**To Reproduce**
30-
31-
Steps to reproduce the behavior:
32-
1. Go to '...'
33-
2. Click on '....'
34-
3. Scroll down to '....'
35-
4. See error
36-
37-
38-
**Expected behavior**
39-
A clear and concise description of what you expected to happen.
40-
41-
**Screenshots**
42-
If applicable, add screenshots to help explain your problem.
43-
44-
**Desktop (please complete the following information):**
45-
- OS: [e.g. iOS]
46-
- Browser: [e.g. chrome, safari]
47-
- Version: [e.g. 22]
48-
49-
**Smartphone (please complete the following information):**
50-
- Device: [e.g. iPhone6]
51-
- OS: [e.g. iOS8.1]
52-
- Browser: [e.g. stock browser, safari]
53-
- Version: [e.g. 22]
54-
55-
**Additional context**
56-
Add any other context about the problem here.
57-
-->
23+
Please describe your strange question.
24+
-->

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Description
2+
3+
<!--
4+
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
5+
-->
6+
7+
Fixes #(issue)
8+
9+
10+
## Type of change
11+
12+
<!--
13+
Please select the desired item checkbox and change it to "[x]", then delete options that are not relevant.
14+
-->
15+
- [ ] Bug fix (non-breaking change which fixes an issue)
16+
- [ ] New feature (non-breaking change which adds functionality)
17+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
18+
- [ ] Documentation update
19+
20+
# How Has This Been Tested?
21+
22+
<!--
23+
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
24+
-->
25+
26+
- [ ] Test A
27+
- [ ] Test B
28+
29+
**Test Configuration**:
30+
* Browerser type & version:
31+
* Operating system:
32+
* Bundler version:
33+
* Ruby version:
34+
* Jekyl version:
35+
36+
37+
# Checklist:
38+
<!-- Select checkboxes by change the "[ ]" to "[x]" -->
39+
- [ ] My code follows the style guidelines of this project
40+
- [ ] I have performed a self-review of my own code
41+
- [ ] I have commented my code, particularly in hard-to-understand areas
42+
- [ ] I have made corresponding changes to the documentation
43+
- [ ] My changes generate no new warnings
44+
- [ ] I have added tests that prove my fix is effective or that my feature works
45+
- [ ] New and existing unit tests pass locally with my changes
46+
- [ ] Any dependent changes have been merged and published in downstream modules

0 commit comments

Comments
 (0)