|
|
|
@ -1,104 +1,104 @@
|
|
|
|
# Contributing Guidelines
|
|
|
|
# Contributing Guidelines
|
|
|
|
|
|
|
|
|
|
|
|
:tada: First of all, thank you for considering contributing to this project! :tada:
|
|
|
|
:tada: _First of all, thank you for considering contributing to this project!_ :tada:
|
|
|
|
|
|
|
|
|
|
|
|
There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into Chirpy itself.
|
|
|
|
There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug
|
|
|
|
|
|
|
|
reports and feature requests or writing code which can be incorporated into Chirpy itself.
|
|
|
|
As a consumer of the open source community, you should make sure that you have gone through the [Wiki][wiki] to understand the project features and how to use it properly. This is to respect the time of the project's developers and maintainers, and to save their energy for other problems that really need to be solved. Please DO NOT email or tweet the project maintainers directly, everything about Chirpy should be left in GitHub issues/PRs.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
**Tips**: If you are new to open source community, here is a very useful article for you — "[How To Ask Questions The Smart Way][ext-reading]".
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## In This Article
|
|
|
|
## In This Article
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
- [General Rules](#general-rules)
|
|
|
|
- [Questions and Requests for Help](#questions-and-requests-for-help)
|
|
|
|
- [Questions and Requests for Help](#questions-and-requests-for-help)
|
|
|
|
- [File a Bug Report](#file-a-bug-report)
|
|
|
|
- [File a Bug Report](#file-a-bug-report)
|
|
|
|
- [Suggest a New Feature](#suggest-a-new-feature)
|
|
|
|
- [Suggest a New Feature](#suggest-a-new-feature)
|
|
|
|
- [Submitting a Pull Request](#submitting-a-pull-request)
|
|
|
|
- [Contributing Code and Documentation Changes](#contributing-code-and-documentation-changes)
|
|
|
|
- [Contributing Code and Documentation Changes](#contributing-code-and-documentation-changes)
|
|
|
|
- [Helpful Resources](#helpful-resources)
|
|
|
|
- [How To Pass the CI Tests](#how-to-pass-the-ci-tests)
|
|
|
|
|
|
|
|
|
|
|
|
## General Rules
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
All contributions should be based on the following rules:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
- You should read through the [Wiki][wiki] to understand the project features and how to use it properly. This is to
|
|
|
|
|
|
|
|
respect the time of the project's developers and
|
|
|
|
|
|
|
|
maintainers, and to save their energy for other problems that really need to be resolved.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
- Use the [latest release version][latest-ver]. If your contribution involves code/documentation changes, update to the
|
|
|
|
|
|
|
|
latest version of the default (`master`) branch.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
- Avoid making duplicate contributions by searching for existing [Issues][issues] / [Discussioins][discus] /
|
|
|
|
|
|
|
|
[Pull Requests][pr], but don't leave any unhelpful comments such as "I have the same problem". Prefer using
|
|
|
|
|
|
|
|
[reactions][gh-reactions] if you simply want to "+1" an existing issue.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
- DO NOT email or tweet the
|
|
|
|
|
|
|
|
project developers and maintainers directly, everything about Chirpy should be left in GitHub.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
**Tips**: If you're new to open source, see "[How To Ask Questions The Smart Way][ext-reading]".
|
|
|
|
|
|
|
|
|
|
|
|
## Questions and Requests for Help
|
|
|
|
## Questions and Requests for Help
|
|
|
|
|
|
|
|
|
|
|
|
We want to make sure that every reasonable question you have is answered appropriately. In most cases, you can get an answer by checking the Wiki and existing issues. Alternatively, you can ask a question in the [Jekyll Forum][forum] and [StackOverflow][stack_overflow], where there are tons of enthusiastic geeks eager to answer your interesting questions.
|
|
|
|
We expect every reasonable question you ask to be answered appropriately. If you want a quick and timely response,
|
|
|
|
|
|
|
|
please ask questions at [Jekyll Talk][jekyll-talk] and [StackOverflow][stack-overflow], where there are tons of
|
|
|
|
|
|
|
|
enthusiastic geeks who will positively answer your challenging questions.
|
|
|
|
|
|
|
|
|
|
|
|
If you can't get an answer in any of the above ways, then open a new issue as your last option. As long as it is not a duplicate / [RTFM][rtfm] / [STFW][stfw] issue, we will respond as soon as possible.
|
|
|
|
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
|
|
|
|
|
|
|
|
duplicate and [RTFM][rtfm] / [STFW][stfw] issue, we will respond as soon as possible.
|
|
|
|
|
|
|
|
|
|
|
|
## File a Bug Report
|
|
|
|
## File a Bug Report
|
|
|
|
|
|
|
|
|
|
|
|
A great way to contribute to the project is to send a detailed issue when you encounter a problem. We always appreciate a well-written, thorough bug report.
|
|
|
|
A great way to contribute to the project is to send a detailed issue when you encounter a problem. We always appreciate
|
|
|
|
|
|
|
|
a well-written, thorough bug report.
|
|
|
|
|
|
|
|
|
|
|
|
- If the issue is caused by you modifying the project code or some configuration of Jekyll, then please **DO NOT** report such "bugs".
|
|
|
|
1. Please figure out why the bug occurred, or locate the module in the project that caused this bug. Otherwise, there is
|
|
|
|
This project is open source, but it doesn't mean that we will maintain other specific projects (such as yours).
|
|
|
|
a high probability that you are using/setting it incorrectly.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2. If the issue is caused by you modifying the project code or some configuration of Jekyll, then please DO NOT
|
|
|
|
|
|
|
|
report such "bugs".
|
|
|
|
|
|
|
|
Chirpy is an open-source project, but that doesn't mean we will maintain other specific forks (such as yours).
|
|
|
|
You can learn about Jekyll and modern Web development to solve problems caused by custom modifications.
|
|
|
|
You can learn about Jekyll and modern Web development to solve problems caused by custom modifications.
|
|
|
|
|
|
|
|
|
|
|
|
- Update to the latest version and see if that solves the problem.
|
|
|
|
3. Make good use of your browser's incognito mode to troubleshoot if the problem is caused by caching.
|
|
|
|
|
|
|
|
|
|
|
|
- Make good use of your browser's incognito mode to troubleshoot if the problem is caused by caching.
|
|
|
|
4. As a last option, you can create a new [Bug Report][new-issue] follow the template to describe the details.
|
|
|
|
|
|
|
|
If possible, providing a demo that reproduces the error will help us troubleshoot faster.
|
|
|
|
- Search for similar issues, but don't leave unhelpful comments such as "I had the same problem". Prefer using [reactions][gh-reactions] if you simply want to "+1" an existing issue.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
- Once you've gone through the above, you can use the bug-report template to create a new issue, filling in the description of the bug according to the template. If you can, provide a small example of the bug that can be reproduced for faster troubleshooting.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Suggest a New Feature
|
|
|
|
## Suggest a New Feature
|
|
|
|
|
|
|
|
|
|
|
|
Feature requests are welcome! While we will consider all requests, we cannot guarantee your request will be accepted.
|
|
|
|
Feature requests are welcome! While we will consider all requests, we cannot guarantee your request will be accepted.
|
|
|
|
|
|
|
|
|
|
|
|
We want to avoid chaos in the UI design, so we won't accept requests for changes like color schemes, font families, typography, and so on. **Do not open a duplicate feature request.** Search for existing feature requests first. If you find your feature (or one very similar) previously requested, comment on that issue.
|
|
|
|
We want to avoid chaos in the UI design, so we won't accept requests for changes like color schemes, font families,
|
|
|
|
|
|
|
|
typography, and so on. **Do not open a duplicate feature request.** Search for existing feature requests first. If you
|
|
|
|
|
|
|
|
find your feature (or one very similar) previously requested, comment on that issue.
|
|
|
|
|
|
|
|
|
|
|
|
If accepted, we cannot make any commitments regarding the timeline for implementation and release. However, you are welcome to submit a pull request to help!
|
|
|
|
If accepted, we cannot make any commitments regarding the timeline for implementation and release. However, you are
|
|
|
|
|
|
|
|
welcome to submit a pull request to help!
|
|
|
|
|
|
|
|
|
|
|
|
## Submitting a Pull Request
|
|
|
|
## Contributing Code and Documentation Changes
|
|
|
|
|
|
|
|
|
|
|
|
### Contributing Code and Documentation Changes
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
In short, you can follow these steps to complete the contribution.
|
|
|
|
In short, you can follow these steps to complete the contribution.
|
|
|
|
|
|
|
|
|
|
|
|
1. Fork this project on GitHub and clone your repository locally.
|
|
|
|
1. Fork this project on GitHub and clone your repository locally.
|
|
|
|
2. Setting up the [development environment][dev-env].
|
|
|
|
2. Setting up the [development & test environments][dev-env].
|
|
|
|
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`). When development is complete, create a [Conventional Commit][cc] with Git. (See also: "[Verify the commits](#verify-the-commits)")
|
|
|
|
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`).
|
|
|
|
4. Create a [Pull Request][gh-pr].
|
|
|
|
When development is complete, create a [Conventional Commit][cc] with Git.
|
|
|
|
|
|
|
|
4. Create a new [Pull Request][gh-pr].
|
|
|
|
|
|
|
|
|
|
|
|
### How To Pass the CI Tests
|
|
|
|
## Helpful Resources
|
|
|
|
|
|
|
|
|
|
|
|
This project has [CI][ci] turned on. In order for your pull request to pass the test,
|
|
|
|
- [Code of conduct](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/.github/CODE_OF_CONDUCT.md)
|
|
|
|
please read the following.
|
|
|
|
- [Security policy](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/.github/SECURITY.md)
|
|
|
|
|
|
|
|
|
|
|
|
#### Verify the Commits
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Before you create a git commit, please complete the following setup.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Install `commitlint` & `husky`:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
|
|
|
npm i -g @commitlint/{cli,config-conventional} husky
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
And then enable `husky`:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
|
|
|
husky install
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### Check the Core Functionality
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
|
|
|
bash ./tools/test
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### Check the SASS Code Style
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
|
|
|
npm test
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[latest-ver]: https://github.com/cotes2020/jekyll-theme-chirpy/releases/latest
|
|
|
|
[wiki]: https://github.com/cotes2020/jekyll-theme-chirpy/wiki
|
|
|
|
[wiki]: https://github.com/cotes2020/jekyll-theme-chirpy/wiki
|
|
|
|
|
|
|
|
[issues]: https://github.com/cotes2020/jekyll-theme-chirpy/issues?q=is%3Aissue
|
|
|
|
|
|
|
|
[pr]: https://github.com/cotes2020/jekyll-theme-chirpy/pulls
|
|
|
|
|
|
|
|
[discus]: https://github.com/cotes2020/jekyll-theme-chirpy/discussions
|
|
|
|
[ext-reading]: http://www.catb.org/~esr/faqs/smart-questions.html
|
|
|
|
[ext-reading]: http://www.catb.org/~esr/faqs/smart-questions.html
|
|
|
|
[forum]: https://talk.jekyllrb.com/
|
|
|
|
[jekyll-talk]: https://talk.jekyllrb.com/
|
|
|
|
[stack_overflow]: https://stackoverflow.com/questions/tagged/jekyll
|
|
|
|
[stack-overflow]: https://stackoverflow.com/questions/tagged/jekyll
|
|
|
|
[rtfm]: https://en.wikipedia.org/wiki/RTFM
|
|
|
|
[rtfm]: https://en.wikipedia.org/wiki/RTFM
|
|
|
|
[stfw]: https://www.webster-dictionary.org/definition/STFW
|
|
|
|
[stfw]: https://www.webster-dictionary.org/definition/STFW
|
|
|
|
[gh-reactions]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/
|
|
|
|
[gh-reactions]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/
|
|
|
|
[dev-env]: https://github.com/cotes2020/jekyll-theme-chirpy/wiki/Development
|
|
|
|
[new-issue]: https://github.com/cotes2020/jekyll-theme-chirpy/issues/new/choose
|
|
|
|
|
|
|
|
[dev-env]: https://github.com/cotes2020/jekyll-theme-chirpy/wiki/Development-&-Test-Environments
|
|
|
|
[cc]: https://www.conventionalcommits.org/
|
|
|
|
[cc]: https://www.conventionalcommits.org/
|
|
|
|
[gh-pr]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests
|
|
|
|
[gh-pr]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests
|
|
|
|
[ci]: https://en.wikipedia.org/wiki/Continuous_integration
|
|
|
|
|
|
|
|
|
Cotes Chung