mirror of
https://github.com/cotes2020/jekyll-theme-chirpy.git
synced 2025-12-18 05:41:31 +00:00
refactor: move project files to docs folder
This commit is contained in:
Cotes Chung
73
.github/CODE_OF_CONDUCT.md
vendored
73
.github/CODE_OF_CONDUCT.md
vendored
@@ -1,73 +0,0 @@
|
||||
# Contributor Covenant Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
In the interest of fostering an open and welcoming environment, we as
|
||||
contributors and maintainers pledge to making participation in our project and
|
||||
our community a harassment-free experience for everyone, regardless of age, body
|
||||
size, 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.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to creating a positive environment include:
|
||||
|
||||
* Using welcoming and inclusive language
|
||||
* Being respectful of differing viewpoints and experiences
|
||||
* Gracefully accepting constructive criticism
|
||||
* Focusing on what is best for the community
|
||||
* Showing empathy towards other community members
|
||||
|
||||
Examples of unacceptable behavior by participants include:
|
||||
|
||||
* The use of sexualized language or imagery and unwelcome sexual attention or advances
|
||||
* Trolling, insulting/derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or electronic address, without explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
|
||||
## Our Responsibilities
|
||||
|
||||
Project maintainers are responsible for clarifying the standards of acceptable
|
||||
behavior and are expected to take appropriate and fair corrective action in
|
||||
response to any instances of unacceptable behavior.
|
||||
|
||||
Project maintainers 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, or to ban temporarily or
|
||||
permanently any contributor for other behaviors that they deem inappropriate,
|
||||
threatening, offensive, or harmful.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies both within project spaces and in public spaces
|
||||
when an individual is representing the project or its community. Examples of
|
||||
representing a project or community include using an official project e-mail
|
||||
address, posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event. Representation of a project may be
|
||||
further defined and clarified by project maintainers.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported by contacting the project team at `cotes.chung@gmail.com`. All
|
||||
complaints will be reviewed and investigated and will result in a response that
|
||||
is deemed necessary and appropriate to the circumstances. The project team is
|
||||
obligated to maintain confidentiality with regard to the reporter of an incident.
|
||||
Further details of specific enforcement policies may be posted separately.
|
||||
|
||||
Project maintainers who do not follow or enforce the Code of Conduct in good
|
||||
faith may face temporary or permanent repercussions as determined by other
|
||||
members of the project's leadership.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
||||
available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
|
||||
|
||||
For answers to common questions about this code of conduct, see
|
||||
<https://www.contributor-covenant.org/faq>
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
104
.github/CONTRIBUTING.md
vendored
104
.github/CONTRIBUTING.md
vendored
@@ -1,104 +0,0 @@
|
||||
# Contributing Guidelines
|
||||
|
||||
: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.
|
||||
|
||||
## In This Article
|
||||
|
||||
- [General Rules](#general-rules)
|
||||
- [Questions and Requests for Help](#questions-and-requests-for-help)
|
||||
- [File a Bug Report](#file-a-bug-report)
|
||||
- [Suggest a New Feature](#suggest-a-new-feature)
|
||||
- [Contributing Code and Documentation Changes](#contributing-code-and-documentation-changes)
|
||||
- [Helpful Resources](#helpful-resources)
|
||||
|
||||
## 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
|
||||
|
||||
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 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
|
||||
|
||||
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.
|
||||
|
||||
1. Please figure out why the bug occurred, or locate the module in the project that caused this bug. Otherwise, there is
|
||||
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.
|
||||
|
||||
3. 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.
|
||||
|
||||
## Suggest a New Feature
|
||||
|
||||
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.
|
||||
|
||||
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!
|
||||
|
||||
## Contributing Code and Documentation Changes
|
||||
|
||||
In short, you can follow these steps to complete the contribution.
|
||||
|
||||
1. Fork this project on GitHub and clone your repository locally.
|
||||
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.
|
||||
4. Create a new [Pull Request][gh-pr].
|
||||
|
||||
## Helpful Resources
|
||||
|
||||
- [Code of conduct](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/.github/CODE_OF_CONDUCT.md)
|
||||
- [Security policy](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/.github/SECURITY.md)
|
||||
|
||||
[latest-ver]: https://github.com/cotes2020/jekyll-theme-chirpy/releases/latest
|
||||
[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
|
||||
[jekyll-talk]: https://talk.jekyllrb.com/
|
||||
[stack-overflow]: https://stackoverflow.com/questions/tagged/jekyll
|
||||
[rtfm]: https://en.wikipedia.org/wiki/RTFM
|
||||
[stfw]: https://www.webster-dictionary.org/definition/STFW
|
||||
[gh-reactions]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/
|
||||
[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/
|
||||
[gh-pr]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests
|
||||
2
.github/ISSUE_TEMPLATE/bug_report.md
vendored
2
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@@ -3,7 +3,7 @@ name: Bug Report
|
||||
about: Create a report to help us improve
|
||||
---
|
||||
|
||||
> **Tips**: Remember, contributions to this repository should follow the [contributing guidelines](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/.github/CONTRIBUTING.md).
|
||||
> **Tips**: Remember, contributions to this repository should follow the [contributing guidelines](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/docs/CONTRIBUTING.md).
|
||||
|
||||
## Describe the bug
|
||||
|
||||
|
||||
3
.github/ISSUE_TEMPLATE/feature_request.md
vendored
3
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@@ -4,8 +4,7 @@ about: Suggest an idea for this project
|
||||
labels: enhancement
|
||||
---
|
||||
|
||||
> **Tips**: Remember, contributions to this repository should follow the
|
||||
[contributing guidelines](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/.github/CONTRIBUTING.md).
|
||||
> **Tips**: Remember, contributions to this repository should follow the [contributing guidelines](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/docs/CONTRIBUTING.md).
|
||||
|
||||
## Is your feature request related to a problem? Please describe
|
||||
|
||||
|
||||
13
.github/SECURITY.md
vendored
13
.github/SECURITY.md
vendored
@@ -1,13 +0,0 @@
|
||||
# Security Policy
|
||||
|
||||
## Supported Versions
|
||||
|
||||
| Version | Supported |
|
||||
|:----------|:---------:|
|
||||
| `6.x` | ✓ |
|
||||
| < `6.0.0` | ✗ |
|
||||
|
||||
## Reporting a Vulnerability
|
||||
|
||||
If you find a vulnerability, please report it to `cotes.chung@gmail.com`.
|
||||
We will try our best to respond within a week. Thank you for your time!
|
||||
1
.github/workflows/ci.yml
vendored
1
.github/workflows/ci.yml
vendored
@@ -8,6 +8,7 @@ on:
|
||||
- ".github/**"
|
||||
- "!.github/workflows/ci.yml"
|
||||
- ".gitignore"
|
||||
- "docs/**"
|
||||
- "README.md"
|
||||
- "LICENSE"
|
||||
pull_request:
|
||||
|
||||
Reference in New Issue
Block a user