Skip to content

Commit 5565931

Browse files
committed
docs: update project docs
1 parent bbd92d1 commit 5565931

File tree

3 files changed

+38
-33
lines changed

3 files changed

+38
-33
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Type of change
2-
<!-- Please select the desired item checkbox and change it to "[x]", then delete options that are not relevant. -->
2+
<!-- Please select the desired item checkbox and change it from `[ ]` to `[x]` and then delete the irrelevant options. -->
33
- [ ] Bug fix (non-breaking change which fixes an issue)
44
- [ ] New feature (non-breaking change which adds functionality)
55
- [ ] Improvement (refactoring and improving code)

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,18 +45,18 @@
4545

4646
## Documentation
4747

48-
To explore usage, development, and upgrade guide of the project, please refer to the [**Wiki**][wiki].
48+
To learn how to use, develop, and upgrade the project, please refer to the [Wiki][wiki].
4949

5050
## Contributing
5151

52-
Contributions (_pull requests_, _issues_ and _discussions_) are what make the open source community such an amazing place
52+
Contributions (_pull requests_, _issues_, and _discussions_) are what make the open source community such an amazing place
5353
to learn, inspire, and create. Any contributions you make are greatly appreciated.
5454
For details, see the "[Contributing Guidelines][contribute-guide]".
5555

5656
## Credits
5757

58-
This theme is mainly built with [Jekyll][jekyllrb] ecosystem,
59-
[Bootstrap][bootstrap], [Font Awesome][icons] and some other [wonderful tools][lib].
58+
This project is mainly built with [Jekyll][jekyllrb] ecosystem,
59+
[Bootstrap][bootstrap], [Font Awesome][icons], and some other [wonderful tools][lib].
6060
The avatar and favicon design come from [Clipart Max][image].
6161

6262
Many thanks to the [contributors][contributors] who participated in the development
@@ -66,15 +66,15 @@ Last but not least, thanks to [JetBrains][jetbrains] for providing the _Open Sou
6666

6767
## Sponsoring
6868

69-
If you like this project, or have built something through it, please consider supporting me in the following ways. Any support would be greatly appreciated!
69+
If you like this project, or have built something through it, please consider supporting this project. Any support would be greatly appreciated!
7070

7171
[![Ko-fi](https://img.shields.io/badge/Support_Me_on_Ko--fi-ff5e5b?logo=ko-fi&logoColor=white)][ko-fi]&nbsp;
7272
[![Wechat Pay](https://img.shields.io/badge/Support_Me_on_WeChat-brightgreen?logo=wechat&logoColor=white)][donation]&nbsp;
7373
[![Alipay](https://img.shields.io/badge/Support_Me_on_Alipay-blue?logo=alipay&logoColor=white)][donation]
7474

7575
## License
7676

77-
This work is published under [MIT License][license].
77+
This project is published under [MIT License][license].
7878

7979
[gem]: https://rubygems.org/gems/jekyll-theme-chirpy
8080
[ci]: https://github.com/cotes2020/jekyll-theme-chirpy/actions/workflows/ci.yml?query=event%3Apush+branch%3Amaster

docs/CONTRIBUTING.md

Lines changed: 31 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,41 @@
11
# Contributing Guidelines
22

3-
:tada: _First of all, thank you for considering contributing to this project!_ :tada:
3+
_First of all, thank you for considering contributing to this project_ ! :tada:
44

55
There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug
6-
reports and feature requests or writing code which can be incorporated into Chirpy itself.
6+
reports and feature requests, or writing code that can be incorporated into the project. In order to make a good
7+
experience for both contributors and maintainers, please start with the "[General Rules](#general-rules)"
8+
before taking further action.
79

8-
## In This Article
10+
## Table of Contents
911

1012
- [General Rules](#general-rules)
1113
- [Questions and Requests for Help](#questions-and-requests-for-help)
12-
- [File a Bug Report](#file-a-bug-report)
13-
- [Suggest a New Feature](#suggest-a-new-feature)
14-
- [Contributing Code and Documentation Changes](#contributing-code-and-documentation-changes)
14+
- [Reporting a Bug](#reporting-a-bug)
15+
- [Suggesting a New Feature](#suggesting-a-new-feature)
16+
- [Contributing Code/Documentation](#contributing-codedocumentation)
1517
- [Helpful Resources](#helpful-resources)
1618

1719
## General Rules
1820

19-
All contributions should be based on the following rules:
21+
All types of contributions (_pull requests_, _issues_, and _discussions_) should follow these rules:
2022

2123
- You should read through the [Wiki][wiki] to understand the project features and how to use it properly. This is to
2224
respect the time of the project's developers and
23-
maintainers, and to save their energy for other problems that really need to be resolved.
25+
maintainers and to save their energy for other problems that really need to be resolved.
2426

2527
- Use the [latest release version][latest-ver]. If your contribution involves code/documentation changes, update to the
2628
latest version of the default (`master`) branch.
2729

28-
- Avoid making duplicate contributions by searching for existing [Issues][issues] / [Discussioins][discus] /
29-
[Pull Requests][pr], but don't leave any unhelpful comments such as "I have the same problem". Prefer using
30+
- Avoid making duplicate contributions by searching for existing [issues][issues] / [discussions][discus] /
31+
[pull requests][pr], but don't leave any unhelpful comments such as "I have the same problem". Prefer using
3032
[reactions][gh-reactions] if you simply want to "+1" an existing issue.
3133

3234
- DO NOT email or tweet the
33-
project developers and maintainers directly, everything about Chirpy should be left in GitHub.
35+
project developers and maintainers directly, everything about the project should be left on GitHub.
3436

35-
**Tips**: If you're new to open source, see "[How To Ask Questions The Smart Way][ext-reading]".
37+
**Tip**: If you are new to the open-source community, then please read through
38+
"[How To Ask Questions The Smart Way][ext-reading]" before contributing.
3639

3740
## Questions and Requests for Help
3841

@@ -43,7 +46,7 @@ enthusiastic geeks who will positively answer your challenging questions.
4346
If you can't get an answer in any of the above ways, then create a new [discussion][discus]. As long as it is not a
4447
duplicate and [RTFM][rtfm] / [STFW][stfw] issue, we will respond as soon as possible.
4548

46-
## File a Bug Report
49+
## Reporting a Bug
4750

4851
A great way to contribute to the project is to send a detailed issue when you encounter a problem. We always appreciate
4952
a well-written, thorough bug report.
@@ -58,34 +61,34 @@ You can learn about Jekyll and modern Web development to solve problems caused b
5861

5962
3. Make good use of your browser's incognito mode to troubleshoot if the problem is caused by caching.
6063

61-
4. As a last option, you can create a new [Bug Report][new-issue] follow the template to describe the details.
64+
4. As a last option, you can create a new [Bug Report][bug-report] following the template to describe the details.
6265
If possible, providing a demo that reproduces the error will help us troubleshoot faster.
6366

64-
## Suggest a New Feature
65-
66-
Feature requests are welcome! While we will consider all requests, we cannot guarantee your request will be accepted.
67-
68-
We want to avoid chaos in the UI design, so we won't accept requests for changes like color schemes, font families,
69-
typography, and so on. **Do not open a duplicate feature request.** Search for existing feature requests first. If you
70-
find your feature (or one very similar) previously requested, comment on that issue.
67+
## Suggesting a New Feature
7168

69+
Feature requests are welcome! While we will consider all requests, we cannot guarantee your request will be accepted.
70+
We want to avoid chaos in the UI design and therefore do not accept requests for changes like color schemes,
71+
fontfamilies, typography, and so on. We want to avoid [feature creep][feat-creep] and focus only on the core features.
7272
If accepted, we cannot make any commitments regarding the timeline for implementation and release. However, you are
7373
welcome to submit a pull request to help!
7474

75-
## Contributing Code and Documentation Changes
75+
## Contributing Code/Documentation
7676

77-
In short, you can follow these steps to complete the contribution.
77+
If your request is about an enhancement, it is recommended to first submit a
78+
[Feature Request][feat-request] to discuss whether your idea fits the project.
79+
See also: "[Suggesting a New Feature](#suggesting-a-new-feature)". Other than that, you can start the PR process.
7880

7981
1. Fork this project on GitHub and clone your repository locally.
8082
2. Setting up the [development & test environments][dev-env].
81-
3. Create a new branch from the default branch and give it a descriptive name (e.g. `add-a-new-feat` or `fix-a-bug`).
83+
3. Creating a new branch from the default branch and give it a descriptive name (e.g. `add-a-new-feat` or `fix-a-bug`).
8284
When development is complete, create a [Conventional Commit][cc] with Git.
83-
4. Create a new [Pull Request][gh-pr].
85+
4. Submitting a [Pull Request][gh-pr].
8486

8587
## Helpful Resources
8688

8789
- [Code of conduct](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/docs/CODE_OF_CONDUCT.md)
8890
- [Security policy](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/docs/SECURITY.md)
91+
- [How To Ask Questions The Smart Way][ext-reading]
8992

9093
[latest-ver]: https://github.com/cotes2020/jekyll-theme-chirpy/releases/latest
9194
[wiki]: https://github.com/cotes2020/jekyll-theme-chirpy/wiki
@@ -98,7 +101,9 @@ When development is complete, create a [Conventional Commit][cc] with Git.
98101
[rtfm]: https://en.wikipedia.org/wiki/RTFM
99102
[stfw]: https://www.webster-dictionary.org/definition/STFW
100103
[gh-reactions]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/
101-
[new-issue]: https://github.com/cotes2020/jekyll-theme-chirpy/issues/new/choose
104+
[bug-report]: https://github.com/cotes2020/jekyll-theme-chirpy/issues/new?assignees=&labels=&projects=&template=bug_report.yml
105+
[feat-request]: https://github.com/cotes2020/jekyll-theme-chirpy/issues/new?assignees=&labels=enhancement&projects=&template=feature_request.yml
106+
[feat-creep]: https://en.wikipedia.org/wiki/Feature_creep
102107
[dev-env]: https://github.com/cotes2020/jekyll-theme-chirpy/wiki/Development-&-Test-Environments
103108
[cc]: https://www.conventionalcommits.org/
104109
[gh-pr]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests

0 commit comments

Comments
 (0)